> **Building with AI coding agents?** Install the authstack plugin with one command. This equips your agent with accurate Scalekit implementation patterns.
>
> **Recommended** (the `-y` flags skip prompts, so the command runs without an interactive terminal):
> ```bash
> npx -y @scalekit-inc/cli setup -y
> ```
>
> Global:
> ```bash
> npm install -g @scalekit-inc/cli
> scalekit setup -y
> ```
>
> Supports Claude Code, Cursor, GitHub Copilot, Codex + skills for other Agent Skills-compatible agents in `~/.agents/skills`.
> Skills: integrate-agentkit, implement-saaskit, add-mcp-oauth, implement-sso, implement-scim.
> [Full setup guide](https://docs.scalekit.com/dev-kit/build-with-ai/)

---

# Connect AI agents to Upsales

The Upsales connector lets your AI agent act in each user's Upsales account. Each user connects their own Upsales API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 60 tools.

**Authentication:** API Key
**Categories:** CRM & Sales
**Tools:** 60: 29 read, 21 write, 10 destructive
**Users sign in with:** API key
**Built by:** Scalekit connector
**Try it:** [Playground in the Scalekit dashboard](https://app.scalekit.com/ws/signup?sk_intent=playground&provider=UPSALES)

## Setup

1. ### Install the SDK

   **Node.js**

   ```bash
   npm install @scalekit-sdk/node dotenv
   ```

   **Python**

   ```bash
   pip install scalekit-sdk-python python-dotenv
   ```

2. ### Set your credentials

   Add your Scalekit credentials to your `.env` file. Find values in **[app.scalekit.com](https://app.scalekit.com)** > **Developers** > **API Credentials**.

   ```sh title=".env"
   SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
   SCALEKIT_CLIENT_ID=<your-client-id>
   SCALEKIT_CLIENT_SECRET=<your-client-secret>
   ```

3. ### Create the Upsales connection

   In **AgentKit > Connections**, create an Upsales connection. The name you give it is the `connection_name` your code passes. See [Configure connections](/agentkit/connections/).

4. ### Authorize a user and make your first call

   **Node.js** (`quickstart.mts`)

   ```typescript
   import { ScalekitClient } from '@scalekit-sdk/node'
   import 'dotenv/config'
   import { createInterface } from 'node:readline/promises'

   const scalekit = new ScalekitClient(
     process.env.SCALEKIT_ENVIRONMENT_URL,
     process.env.SCALEKIT_CLIENT_ID,
     process.env.SCALEKIT_CLIENT_SECRET,
   )
   const actions = scalekit.actions

   const connector = 'upsales'
   const identifier = 'user_123'

   // Generate an authorization link for the user
   const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
   console.log('Authorize Upsales:', link)
   const rl = createInterface({ input: process.stdin, output: process.stdout })
   await rl.question('Press Enter after authorizing...')
   rl.close()

   // Make your first call
   const result = await actions.executeTool({
     connector,
     identifier,
     toolName: 'upsales_activities_list',
     toolInput: {},
   })
   console.log(result)
   ```

   ```bash
   npx tsx quickstart.mts
   ```

   **Python** (`quickstart.py`)

   ```python
   import os
   from scalekit import ScalekitClient
   from dotenv import load_dotenv
   load_dotenv()

   scalekit_client = ScalekitClient(
       env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),
       client_id=os.getenv("SCALEKIT_CLIENT_ID"),
       client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),
   )
   actions = scalekit_client.actions

   connection_name = "upsales"
   identifier = "user_123"

   # Generate an authorization link for the user
   link_response = actions.get_authorization_link(
       connection_name=connection_name,
       identifier=identifier,
   )
   print("Authorize Upsales:", link_response.link)
   input("Press Enter after authorizing...")

   # Make your first call
   result = actions.execute_tool(
       tool_input={},
       tool_name="upsales_activities_list",
       connection_name=connection_name,
       identifier=identifier,
   )
   print(result)
   ```

   ```bash
   python quickstart.py
   ```

   Each user opens the link once and enters their Upsales credentials there. See [Authorize a user](/agentkit/tools/authorize/) for the full flow and statuses.

## Tools

Pass the exact name to `execute_tool`, with an input like each tool's example. To ask for a tool that's missing, use the [request form](https://scalekitsupport.portal.usepylon.com/forms/request-a-connector-tool).

**Node.js**

```typescript
const result = await actions.executeTool({
  toolName: 'upsales_activities_list',
  toolInput: {},
  connector: 'upsales',
  identifier: 'user_123',
})
```

**Python**

```python
result = actions.execute_tool(
    tool_name="upsales_activities_list",
    tool_input={},
    connection_name="upsales",
    identifier="user_123",
)
```

`result.data` is the app's response as JSON, and `result.execution_id` (`executionId` in Node.js) is the ID of the call.

### `upsales_activities_list`

List Activities · Read-only

List activities (tasks such as phone calls and to-dos), optionally by company, user or date, with limit/offset paging. Returns activities with description, date, type, company, contacts and close date.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `close_date` (`string`, optional): Filter by close date; null for open activities. Prefix a comparison to filter by range: eq:, ne:, gt:, gte:, lt: or lte: (for example gte:2026-01-01). Example: null.
- `company_id` (`integer`, optional): Only activities of this company ID. Example: 2.
- `date` (`string`, optional): Filter by activity date (YYYY-MM-DD). Prefix a comparison to filter by range: eq:, ne:, gt:, gte:, lt: or lte: (for example gte:2026-01-01). Example: gte:2026-01-01.
- `limit` (`integer`, optional): Number of records to return, up to 2000. Defaults to 1000. Example: 50.
- `offset` (`integer`, optional): Number of records to skip, for paging. Example: 0.
- `sort` (`string`, optional): Field to sort by; prefix with - for descending, for example -regDate. Example: date.
- `user_id` (`integer`, optional): Only activities of this user ID. Example: 1.

Example input: `{}`

### `upsales_activity_get`

Get Activity · Read-only

Get one activity (phone call or to-do) by ID. Returns the activity.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `activity_id` (`integer`, required): Activity ID, from upsales_activities_list. Example: 45.

Example input: `{"activity_id":45}`

### `upsales_activity_types_list`

List Activity Types · Read-only

List the activity types (for example phone call and to-do). Returns type IDs and names to use as activity_type_id.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `upsales_appointment_types_list`

List Appointment Types · Read-only

List the appointment types (for example first meeting, demo). Returns type IDs and names to use as activity_type_id.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `upsales_appointments_list`

List Appointments · Read-only

List appointments (meetings), optionally by company, user or date, with limit/offset paging. Returns appointments with start and end, description, type, company and attendees.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `company_id` (`integer`, optional): Only appointments of this company ID. Example: 2.
- `date` (`string`, optional): Filter by start date. Prefix a comparison to filter by range: eq:, ne:, gt:, gte:, lt: or lte: (for example gte:2026-01-01). Example: gte:2026-01-01.
- `limit` (`integer`, optional): Number of records to return, up to 2000. Defaults to 1000. Example: 50.
- `offset` (`integer`, optional): Number of records to skip, for paging. Example: 0.
- `sort` (`string`, optional): Field to sort by; prefix with - for descending, for example -regDate. Example: date.
- `user_id` (`integer`, optional): Only appointments of this user ID. Example: 1.

Example input: `{}`

### `upsales_campaign_get`

Get Campaign · Read-only

Get one campaign. Returns the campaign.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `campaign_id` (`integer`, required): Campaign ID, from upsales_campaigns_list. Example: 4.

Example input: `{"campaign_id":4}`

### `upsales_campaigns_list`

List Campaigns · Read-only

List campaigns (called projects in the API), optionally only active ones, with limit/offset paging. Returns campaign IDs, names, dates and users.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `active` (`integer`, optional): 1 for active campaigns, 0 for inactive. Example: 1. One of: `0`, `1`.
- `limit` (`integer`, optional): Number of records to return, up to 2000. Defaults to 1000. Example: 50.
- `offset` (`integer`, optional): Number of records to skip, for paging. Example: 0.
- `sort` (`string`, optional): Field to sort by; prefix with - for descending, for example -regDate. Example: id.

Example input: `{}`

### `upsales_comments_list`

List Comments · Read-only

List comments (notes) on companies, tickets or opportunities, with limit/offset paging. Returns comments with text, author and pinned flag.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `company_id` (`integer`, optional): Only comments on this company ID. Example: 12.
- `limit` (`integer`, optional): Number of records to return, up to 2000. Defaults to 1000. Example: 50.
- `offset` (`integer`, optional): Number of records to skip, for paging. Example: 0.
- `opportunity_id` (`string`, optional): Only comments on this opportunity, for example eq:900. Example: eq:900.
- `sort` (`string`, optional): Field to sort by; prefix with - for descending, for example -regDate. Example: -regDate.
- `ticket_id` (`string`, optional): Only comments on this ticket, for example eq:400. Example: eq:400.

Example input: `{}`

### `upsales_companies_list`

List Companies · Read-only

List companies (accounts), optionally filtered by name, responsible user or external flag, with limit/offset paging. Returns companies with name, phone, web page, users and custom fields, plus a total in metadata. Use upsales_company_get for one company.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `is_external` (`integer`, optional): 0 for your own CRM companies, 1 for external (prospecting) ones. Example: 0. One of: `0`, `1`.
- `limit` (`integer`, optional): Number of records to return, up to 2000. Defaults to 1000. Example: 50.
- `name` (`string`, optional): Filter by company name (exact match unless a comparison prefix is used). Example: Salesboard.
- `offset` (`integer`, optional): Number of records to skip, for paging. Example: 0.
- `sort` (`string`, optional): Field to sort by; prefix with - for descending, for example -regDate. Example: id.
- `user_id` (`integer`, optional): Only companies with this responsible user ID. Example: 1.

Example input: `{}`

### `upsales_company_get`

Get Company · Read-only

Get one company by ID with its contacts summary, users, categories, address and custom fields. Returns the company.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `company_id` (`integer`, required): Company ID, from upsales_companies_list. Example: 12.

Example input: `{"company_id":12}`

### `upsales_contact_get`

Get Contact · Read-only

Get one contact by ID with their company, phones, email and custom fields. Returns the contact.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `contact_id` (`integer`, required): Contact ID, from upsales_contacts_list. Example: 3.

Example input: `{"contact_id":3}`

### `upsales_contacts_list`

List Contacts · Read-only

List contacts, optionally filtered by company, email or name, with limit/offset paging. Returns contacts with name, title, phones, email and company. Use upsales_contact_get for one contact.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `company_id` (`integer`, optional): Only contacts of this company ID. Example: 2.
- `email` (`string`, optional): Filter by email address. Example: erlich.bachman@piedpiper.com.
- `limit` (`integer`, optional): Number of records to return, up to 2000. Defaults to 1000. Example: 50.
- `name` (`string`, optional): Filter by full name. Example: Erlich Bachman.
- `offset` (`integer`, optional): Number of records to skip, for paging. Example: 0.
- `sort` (`string`, optional): Field to sort by; prefix with - for descending, for example -regDate. Example: id.

Example input: `{}`

### `upsales_custom_fields_list`

List Custom Fields · Read-only

List the custom fields defined for one record type. Returns field IDs, names and types; use the IDs as fieldId in custom values.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `entity` (`string`, required): Record type. Example: account. One of: `account`, `contact`, `activity`, `appointment`, `order`, `orderrow`, `product`, `project`, `user`, `agreement`.

Example input: `{"entity":"account"}`

### `upsales_order_get`

Get Opportunity or Order · Read-only

Get one opportunity or order by ID with its rows, stage, probability, value and company. Returns the order.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `order_id` (`integer`, required): Order ID, from upsales_orders_list. Example: 900.

Example input: `{"order_id":900}`

### `upsales_order_stage_get`

Get Stage · Read-only

Get one opportunity or order stage. Returns the stage.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `stage_id` (`integer`, required): Stage ID, from upsales_order_stages_list. Example: 9.

Example input: `{"stage_id":9}`

### `upsales_order_stages_list`

List Stages · Read-only

List the opportunity and order stages with their probability. Returns stage IDs, names and probabilities.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `upsales_orders_list`

List Opportunities and Orders · Read-only

List opportunities and orders (an order is an opportunity at 100% probability), optionally by probability, company, user, stage or date, with limit/offset paging. Returns them with value, stage, company and rows. Filter probability with 100 for won orders or gte:1 for opportunities still open.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `company_id` (`integer`, optional): Only this company ID. Example: 2.
- `date` (`string`, optional): Filter by close date. Prefix a comparison to filter by range: eq:, ne:, gt:, gte:, lt: or lte: (for example gte:2026-01-01). Example: gte:2026-01-01.
- `limit` (`integer`, optional): Number of records to return, up to 2000. Defaults to 1000. Example: 50.
- `offset` (`integer`, optional): Number of records to skip, for paging. Example: 0.
- `probability` (`string`, optional): Filter by probability: 100 for won orders, 0 for lost, or a comparison such as gte:1 for open opportunities. Example: 100.
- `sort` (`string`, optional): Field to sort by; prefix with - for descending, for example -regDate. Example: -date.
- `stage_id` (`integer`, optional): Only this stage ID, from upsales_order_stages_list. Example: 9.
- `user_id` (`integer`, optional): Only this user ID. Example: 1.

Example input: `{}`

### `upsales_price_list_get`

Get Price List · Read-only

Get one price list. Returns the price list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `price_list_id` (`integer`, required): Price list ID, from upsales_price_lists_list. Example: 1.

Example input: `{"price_list_id":1}`

### `upsales_price_lists_list`

List Price Lists · Read-only

List price lists with code, active and default flags. Returns price list IDs.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `upsales_product_categories_list`

List Product Categories · Read-only

List product categories with their parent category. Returns category IDs and names.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `upsales_product_category_get`

Get Product Category · Read-only

Get one product category. Returns the category.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `product_category_id` (`integer`, required): Product category ID, from upsales_product_categories_list. Example: 2.

Example input: `{"product_category_id":2}`

### `upsales_product_get`

Get Product · Read-only

Get one product with its prices, category and custom fields. Returns the product.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `product_id` (`integer`, required): Product ID, from upsales_products_list. Example: 1.
- `use_price_lists` (`boolean`, optional): Set to true to include prices per price list. Example: true.

Example input: `{"product_id":1}`

### `upsales_products_list`

List Products · Read-only

List products with list price, category and active flag, with limit/offset paging; with use_price_lists true, prices per price list and currency are included.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `active` (`integer`, optional): 1 for active products, 0 for inactive. Example: 1. One of: `0`, `1`.
- `limit` (`integer`, optional): Number of records to return, up to 2000. Defaults to 1000. Example: 50.
- `offset` (`integer`, optional): Number of records to skip, for paging. Example: 0.
- `sort` (`string`, optional): Field to sort by; prefix with - for descending, for example -regDate. Example: id.
- `use_price_lists` (`boolean`, optional): Set to true to include prices per price list. Example: true.

Example input: `{}`

### `upsales_self_get`

Get Current User · Read-only

Get the user and account behind the API key, with roles, currency and enabled features. Returns the self object. Use it as a connection check.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `upsales_subscription_get`

Get Subscription · Read-only

Get one subscription with its rows and metadata (period, start, renewal and end dates). Returns the subscription.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `subscription_id` (`integer`, required): Subscription ID, from upsales_subscriptions_list. Example: 77.

Example input: `{"subscription_id":77}`

### `upsales_subscriptions_list`

List Subscriptions · Read-only

List subscriptions (agreements) with their recurring value, period, start and end dates and company, with limit/offset paging.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `company_id` (`integer`, optional): Only subscriptions of this company ID. Example: 101.
- `limit` (`integer`, optional): Number of records to return, up to 2000. Defaults to 1000. Example: 50.
- `offset` (`integer`, optional): Number of records to skip, for paging. Example: 0.
- `sort` (`string`, optional): Field to sort by; prefix with - for descending, for example -regDate. Example: id.

Example input: `{}`

### `upsales_ticket_get`

Get Support Ticket · Read-only

Get one ticket with its comments, status, custom fields and linked records. Returns the ticket.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `ticket_id` (`integer`, required): Ticket ID, from upsales_tickets_list. Example: 400.

Example input: `{"ticket_id":400}`

### `upsales_tickets_list`

List Support Tickets · Read-only

List support tickets, optionally by status, company, user or registration date, with limit/offset paging. Returns tickets with title, status, type, priority and company.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `company_id` (`integer`, optional): Only tickets of this company ID. Example: 12.
- `limit` (`integer`, optional): Number of records to return, up to 2000. Defaults to 1000. Example: 50.
- `offset` (`integer`, optional): Number of records to skip, for paging. Example: 0.
- `reg_date` (`string`, optional): Filter by created date. Prefix a comparison to filter by range: eq:, ne:, gt:, gte:, lt: or lte: (for example gte:2026-01-01). Example: gte:2026-01-01.
- `sort` (`string`, optional): Field to sort by; prefix with - for descending, for example -regDate. Example: -regDate.
- `status_id` (`string`, optional): Filter by status ID, for example eq:3. Example: eq:1.
- `user_id` (`integer`, optional): Only tickets assigned to this user ID. Example: 8.

Example input: `{}`

### `upsales_users_list`

List Users · Read-only

List the users of the Upsales account. Returns user IDs, names, emails and roles to use as user_id or user_ids.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `upsales_activity_create`

Create Activity · Write

Create an activity such as a phone call or to-do, for users and optionally a company and contacts. Returns the new activity. Get activity type IDs from upsales_activity_types_list.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `activity_type_id` (`integer`, required): Activity type ID, from upsales_activity_types_list. Example: 11.
- `description` (`string`, required): What the activity is about. Example: Book a meeting.
- `close_date` (`string`, optional): Date the activity was completed (YYYY-MM-DD); set it to mark the activity done. Example: 2026-02-10.
- `company_id` (`integer`, optional): Company (account) ID, from upsales_companies_list. Example: 2.
- `contact_ids` (`array`, optional): Contact IDs involved, from upsales_contacts_list. Example: [3]
- `date` (`string`, optional): Due date (YYYY-MM-DD). Example: 2026-02-10.
- `notes` (`string`, optional): Notes. Example: No answer, follow up tomorrow.
- `priority` (`integer`, optional): Priority, 0 (none) to 3 (high). Example: 3.
- `user_ids` (`array`, optional): Upsales user IDs responsible, from upsales_users_list. Example: [1]

Example input: `{"activity_type_id":11,"description":"<description>"}`

### `upsales_activity_update`

Update Activity · Write

Update an activity's description, date, notes, people or type, or mark it done with close_date. Returns the activity.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `activity_id` (`integer`, required): Activity ID, from upsales_activities_list. Example: 45.
- `activity_type_id` (`integer`, optional): Activity type ID. Example: 11.
- `close_date` (`string`, optional): Date the activity was completed (YYYY-MM-DD); set it to mark the activity done. Example: 2026-02-10.
- `company_id` (`integer`, optional): Company (account) ID, from upsales_companies_list. Example: 2.
- `contact_ids` (`array`, optional): Contact IDs involved, from upsales_contacts_list. Example: [3]
- `date` (`string`, optional): Due date (YYYY-MM-DD). Example: 2026-02-10.
- `description` (`string`, optional): New description. Example: Book a meeting.
- `notes` (`string`, optional): Notes. Example: No answer, follow up tomorrow.
- `priority` (`integer`, optional): Priority, 0 (none) to 3 (high). Example: 3.
- `user_ids` (`array`, optional): Upsales user IDs responsible, from upsales_users_list. Example: [1]

Example input: `{"activity_id":45}`

### `upsales_appointment_create`

Create Appointment · Write

Book an appointment (meeting) with a start and end, type, users, company and contacts. Returns the new appointment. Get type IDs from upsales_appointment_types_list.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `activity_type_id` (`integer`, required): Appointment type ID, from upsales_appointment_types_list. Example: 7.
- `date` (`string`, required): Start time, ISO 8601. Example: 2026-02-10T09:00:00.000Z.
- `is_appointment` (`boolean`, required): Must be true. Example: true.
- `company_id` (`integer`, optional): Company ID, from upsales_companies_list. Example: 2.
- `contact_ids` (`array`, optional): Contact IDs involved, from upsales_contacts_list. Example: [3]
- `description` (`string`, optional): Meeting subject. Example: Requirements analysis.
- `end_date` (`string`, optional): End time, ISO 8601. Example: 2026-02-10T10:00:00.000Z.
- `notes` (`string`, optional): Notes. Example: Bring the pricing deck.
- `user_ids` (`array`, optional): Upsales user IDs responsible, from upsales_users_list. Example: [1]

Example input: `{"activity_type_id":7,"date":"<date>","is_appointment":true}`

### `upsales_appointment_update`

Update Appointment · Write

Reschedule an appointment or change its description, type, attendees, company or notes. Returns the appointment.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `appointment_id` (`integer`, required): Appointment ID, from upsales_appointments_list. Example: 88.
- `activity_type_id` (`integer`, optional): Appointment type ID. Example: 7.
- `company_id` (`integer`, optional): Company ID, from upsales_companies_list. Example: 2.
- `contact_ids` (`array`, optional): Contact IDs involved, from upsales_contacts_list. Example: [3]
- `date` (`string`, optional): New start time, ISO 8601. Example: 2026-02-11T09:00:00.000Z.
- `description` (`string`, optional): Meeting subject. Example: Requirements analysis.
- `end_date` (`string`, optional): End time, ISO 8601. Example: 2026-02-10T10:00:00.000Z.
- `notes` (`string`, optional): Notes. Example: Bring the pricing deck.
- `user_ids` (`array`, optional): Upsales user IDs responsible, from upsales_users_list. Example: [1]

Example input: `{"appointment_id":88}`

### `upsales_campaign_create`

Create Campaign · Write

Create a campaign with name, dates, active flag and users. Returns the new campaign.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `name` (`string`, required): Campaign name. Example: Sales campaign April.
- `active` (`integer`, optional): 1 for active, 0 to hide the campaign. Example: 1. One of: `0`, `1`.
- `end_date` (`string`, optional): End date (YYYY-MM-DD). Example: 2026-04-30.
- `notes` (`string`, optional): Notes. Example: Spring push for SMB.
- `start_date` (`string`, optional): Start date (YYYY-MM-DD). Example: 2026-04-01.
- `user_ids` (`array`, optional): Upsales user IDs responsible, from upsales_users_list. Example: [1]

Example input: `{"name":"<name>"}`

### `upsales_campaign_update`

Update Campaign · Write

Update a campaign's name, dates, users or notes, or deactivate it with active 0. Returns the campaign.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `campaign_id` (`integer`, required): Campaign ID, from upsales_campaigns_list. Example: 4.
- `active` (`integer`, optional): 1 for active, 0 to hide the campaign. Example: 1. One of: `0`, `1`.
- `end_date` (`string`, optional): End date (YYYY-MM-DD). Example: 2026-04-30.
- `name` (`string`, optional): New name. Example: Sales campaign April.
- `notes` (`string`, optional): Notes. Example: Spring push for SMB.
- `start_date` (`string`, optional): Start date (YYYY-MM-DD). Example: 2026-04-01.
- `user_ids` (`array`, optional): Upsales user IDs responsible, from upsales_users_list. Example: [1]

Example input: `{"campaign_id":4}`

### `upsales_comment_create`

Create Comment · Write

Add a comment (note) to a company, contact, opportunity or ticket. Returns the new comment.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `description` (`string`, required): Comment text. Example: Renewal conversation started, decision expected in Q3.
- `user_id` (`integer`, required): Author user ID, from upsales_users_list. Example: 5.
- `company_id` (`integer`, optional): Company ID to attach to. Example: 12.
- `contact_id` (`integer`, optional): Contact ID to attach to. Example: 340.
- `is_pinned` (`boolean`, optional): Set to true to pin the comment. Example: false.
- `opportunity_id` (`integer`, optional): Opportunity ID to attach to. Example: 900.
- `ticket_id` (`integer`, optional): Ticket ID to attach to. Example: 400.

Example input: `{"description":"<description>","user_id":5}`

### `upsales_comment_update`

Update Comment · Write

Edit a comment's text or pin it. Returns the comment. A comment cannot be moved to another record.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `comment_id` (`integer`, required): Comment ID, from upsales_comments_list. Example: 55.
- `description` (`string`, optional): New text. Example: Renewal signed 12 June.
- `is_pinned` (`boolean`, optional): Set to true to pin, false to unpin. Example: true.

Example input: `{"comment_id":55}`

### `upsales_company_create`

Create Company · Write

Create a company (account) with name, phone, website, responsible users and custom fields. Returns the new company.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `name` (`string`, required): Company name. Example: Salesboard.
- `custom` (`array`, optional): Custom field values, each {"fieldId": <id>, "value": <value>}; field IDs from upsales_custom_fields_list. Example: [{"fieldId": 3, "value": "2210"}]
- `notes` (`string`, optional): Notes about the company. Example: Key account since 2024.
- `phone` (`string`, optional): Main phone number. Example: +46 8 123 456.
- `user_ids` (`array`, optional): Upsales user IDs responsible, from upsales_users_list. Example: [1]
- `webpage` (`string`, optional): Website URL. Example: https://salesboard.com.

Example input: `{"name":"<name>"}`

### `upsales_company_update`

Update Company · Write

Update a company's name, phone, website, notes, responsible users or custom fields; fields left empty are unchanged. Returns the company.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `company_id` (`integer`, required): Company ID, from upsales_companies_list. Example: 12.
- `custom` (`array`, optional): Custom field values, each {"fieldId": <id>, "value": <value>}; field IDs from upsales_custom_fields_list. Example: [{"fieldId": 3, "value": "2210"}]
- `name` (`string`, optional): New company name. Example: Salesboard AB.
- `notes` (`string`, optional): Notes about the company. Example: Key account since 2024.
- `phone` (`string`, optional): Main phone number. Example: +46 8 123 456.
- `user_ids` (`array`, optional): Upsales user IDs responsible, from upsales_users_list. Example: [1]
- `webpage` (`string`, optional): Website URL. Example: https://salesboard.com.

Example input: `{"company_id":12}`

### `upsales_contact_create`

Create Contact · Write

Create a contact with first and last name, phones, email, title and company. Returns the new contact.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `first_name` (`string`, required): First name. Example: Erlich.
- `active` (`integer`, optional): 1 for active, 0 for inactive. Example: 1. One of: `0`, `1`.
- `cell_phone` (`string`, optional): Mobile phone number. Example: 0732231312.
- `company_id` (`integer`, optional): Company (account) ID, from upsales_companies_list. Example: 2.
- `custom` (`array`, optional): Custom field values, each {"fieldId": <id>, "value": <value>}; field IDs from upsales_custom_fields_list. Example: [{"fieldId": 3, "value": "2210"}]
- `email` (`string`, optional): Email address. Example: erlich.bachman@piedpiper.com.
- `last_name` (`string`, optional): Last name. Example: Bachman.
- `phone` (`string`, optional): Phone number. Example: 08-860 804 04.
- `title` (`string`, optional): Job title. Example: Software designer.

Example input: `{"first_name":"<first_name>"}`

### `upsales_contact_update`

Update Contact · Write

Update a contact's name, phones, email, title, company or active flag; fields left empty are unchanged. Returns the contact.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `contact_id` (`integer`, required): Contact ID, from upsales_contacts_list. Example: 3.
- `active` (`integer`, optional): 1 for active, 0 for inactive. Example: 1. One of: `0`, `1`.
- `cell_phone` (`string`, optional): Mobile phone number. Example: 0732231312.
- `company_id` (`integer`, optional): Company (account) ID, from upsales_companies_list. Example: 2.
- `custom` (`array`, optional): Custom field values, each {"fieldId": <id>, "value": <value>}; field IDs from upsales_custom_fields_list. Example: [{"fieldId": 3, "value": "2210"}]
- `email` (`string`, optional): Email address. Example: erlich.bachman@piedpiper.com.
- `first_name` (`string`, optional): New first name. Example: Erlich.
- `last_name` (`string`, optional): New last name. Example: Bachman.
- `phone` (`string`, optional): Phone number. Example: 08-860 804 04.
- `title` (`string`, optional): Job title. Example: Software designer.

Example input: `{"contact_id":3}`

### `upsales_order_create`

Create Opportunity or Order · Write

Create an opportunity (probability below 100) or a won order (probability 100) for a company with stage, user, close date and product rows. Returns the new order.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `company_id` (`integer`, required): Company ID, from upsales_companies_list. Example: 2.
- `description` (`string`, required): Description. Example: 10 licenses.
- `stage_id` (`integer`, required): Stage ID, from upsales_order_stages_list. Example: 9.
- `campaign_id` (`integer`, optional): Campaign ID, from upsales_campaigns_list. Example: 4.
- `currency` (`string`, optional): Currency code; defaults to the master currency. Example: SEK.
- `custom` (`array`, optional): Custom field values, each {"fieldId": <id>, "value": <value>}; field IDs from upsales_custom_fields_list. Example: [{"fieldId": 3, "value": "2210"}]
- `date` (`string`, optional): Expected or actual close date (YYYY-MM-DD). Example: 2026-03-31.
- `notes` (`string`, optional): Notes. Example: Decision expected in March.
- `order_rows` (`array`, optional): Rows, each {quantity, price, listPrice, purchaseCost, product: {id}}; product IDs from upsales_products_list. Example: [{"quantity": 1, "price": 9000, "listPrice": 10000, "product": {"id": 1}}]
- `probability` (`integer`, optional): Probability 0 to 100; 100 makes it an order. Example: 25.
- `user_id` (`integer`, optional): Responsible user ID. Example: 1.

Example input: `{"company_id":2,"description":"<description>","stage_id":9}`

### `upsales_order_update`

Update Opportunity or Order · Write

Update an opportunity or order: stage, probability, close date, rows, user or notes. Sending order_rows replaces the rows. Returns the order.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `order_id` (`integer`, required): Order ID, from upsales_orders_list. Example: 900.
- `campaign_id` (`integer`, optional): Campaign ID, from upsales_campaigns_list. Example: 4.
- `company_id` (`integer`, optional): Company ID. Example: 2.
- `currency` (`string`, optional): Currency code; defaults to the master currency. Example: SEK.
- `custom` (`array`, optional): Custom field values, each {"fieldId": <id>, "value": <value>}; field IDs from upsales_custom_fields_list. Example: [{"fieldId": 3, "value": "2210"}]
- `date` (`string`, optional): Expected or actual close date (YYYY-MM-DD). Example: 2026-03-31.
- `description` (`string`, optional): New description. Example: 12 licenses.
- `notes` (`string`, optional): Notes. Example: Decision expected in March.
- `order_rows` (`array`, optional): Rows, each {quantity, price, listPrice, purchaseCost, product: {id}}; product IDs from upsales_products_list. Example: [{"quantity": 1, "price": 9000, "listPrice": 10000, "product": {"id": 1}}]
- `probability` (`integer`, optional): Probability 0 to 100; 100 makes it an order. Example: 25.
- `stage_id` (`integer`, optional): Stage ID. Example: 10.
- `user_id` (`integer`, optional): Responsible user ID. Example: 1.

Example input: `{"order_id":900}`

### `upsales_product_category_create`

Create Product Category · Write

Create a product category, optionally under a parent. Returns the new category.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `name` (`string`, required): Category name. Example: One-off products.
- `parent_id` (`integer`, optional): Parent category ID. Example: 1.

Example input: `{"name":"<name>"}`

### `upsales_product_category_update`

Update Product Category · Write

Rename a product category or move it under another parent. Returns the category.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `product_category_id` (`integer`, required): Product category ID, from upsales_product_categories_list. Example: 2.
- `name` (`string`, optional): New name. Example: Services.
- `parent_id` (`integer`, optional): New parent category ID. Example: 1.

Example input: `{"product_category_id":2}`

### `upsales_product_create`

Create Product · Write

Create a product with name, list price, category and active flag. Returns the new product.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `list_price` (`number`, required): List price. Example: 20000.
- `name` (`string`, required): Product name. Example: SaaS product.
- `active` (`integer`, optional): 1 for active, 0 to disable the product (products cannot be deleted). Example: 1. One of: `0`, `1`.
- `category_id` (`integer`, optional): Product category ID, from upsales_product_categories_list. Example: 2.
- `custom` (`array`, optional): Custom field values, each {"fieldId": <id>, "value": <value>}; field IDs from upsales_custom_fields_list. Example: [{"fieldId": 3, "value": "2210"}]
- `is_recurring` (`integer`, optional): 1 for a subscription product. Example: 1. One of: `0`, `1`.
- `purchase_cost` (`number`, optional): Purchase cost. Example: 4500.

Example input: `{"list_price":20000,"name":"<name>"}`

### `upsales_product_update`

Update Product · Write

Update a product's name, price, category or cost, or disable it with active 0. Returns the product.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `product_id` (`integer`, required): Product ID, from upsales_products_list. Example: 1.
- `active` (`integer`, optional): 1 for active, 0 to disable the product (products cannot be deleted). Example: 1. One of: `0`, `1`.
- `category_id` (`integer`, optional): Product category ID, from upsales_product_categories_list. Example: 2.
- `custom` (`array`, optional): Custom field values, each {"fieldId": <id>, "value": <value>}; field IDs from upsales_custom_fields_list. Example: [{"fieldId": 3, "value": "2210"}]
- `is_recurring` (`integer`, optional): 1 for a subscription product. Example: 1. One of: `0`, `1`.
- `list_price` (`number`, optional): New list price. Example: 30000.
- `name` (`string`, optional): New name. Example: SaaS product.
- `purchase_cost` (`number`, optional): Purchase cost. Example: 4500.

Example input: `{"product_id":1}`

### `upsales_ticket_comment_add`

Add Ticket Comment · Write

Add a reply to a ticket; public comments are emailed to the customer, private ones are internal notes. Returns the comment.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `description` (`string`, required): Comment text. Example: We have reset the account, please try again.
- `is_public` (`boolean`, required): true sends it to the customer, false keeps it internal. Example: false.
- `ticket_id` (`integer`, required): Ticket ID, from upsales_tickets_list. Example: 400.
- `user_id` (`integer`, optional): User ID of the author. Example: 8.

Example input: `{"description":"<description>","is_public":true,"ticket_id":400}`

### `upsales_ticket_create`

Create Support Ticket · Write

Create a support ticket with title, status and type, optionally for a company and contact and assigned to a user. Returns the new ticket.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `status_id` (`integer`, required): Ticket status ID that exists on the account. Example: 1.
- `title` (`string`, required): Ticket title. Example: Cannot log in to the mobile app.
- `type_id` (`integer`, required): Ticket type ID that exists on the account. Example: 1.
- `company_id` (`integer`, optional): Company ID. Example: 12.
- `contact_id` (`integer`, optional): Contact ID of the requester. Example: 340.
- `custom` (`array`, optional): Custom field values, each {"fieldId": <id>, "value": <value>}; field IDs from upsales_custom_fields_list. Example: [{"fieldId": 3, "value": "2210"}]
- `priority` (`integer`, optional): Priority, 0 (none) to 3 (urgent). Example: 2.
- `user_id` (`integer`, optional): Assigned user ID (needs a support licence). Example: 5.

Example input: `{"status_id":1,"title":"<title>","type_id":1}`

### `upsales_ticket_update`

Update Support Ticket · Write

Reassign a ticket, change its status, type, priority or title. Returns the ticket.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `ticket_id` (`integer`, required): Ticket ID, from upsales_tickets_list. Example: 400.
- `company_id` (`integer`, optional): Company ID. Example: 12.
- `contact_id` (`integer`, optional): Contact ID of the requester. Example: 340.
- `custom` (`array`, optional): Custom field values, each {"fieldId": <id>, "value": <value>}; field IDs from upsales_custom_fields_list. Example: [{"fieldId": 3, "value": "2210"}]
- `priority` (`integer`, optional): Priority, 0 (none) to 3 (urgent). Example: 2.
- `status_id` (`integer`, optional): New status ID. Example: 3.
- `title` (`string`, optional): New title. Example: Cannot log in to the iOS app.
- `type_id` (`integer`, optional): New type ID. Example: 1.
- `user_id` (`integer`, optional): Assigned user ID (needs a support licence). Example: 5.

Example input: `{"ticket_id":400}`

### `upsales_activity_delete`

Delete Activity · Destructive

Delete an activity. Returns the result.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `activity_id` (`integer`, required): Activity ID, from upsales_activities_list. Example: 45.

Example input: `{"activity_id":45}`

### `upsales_appointment_delete`

Delete Appointment · Destructive

Delete an appointment. Returns the result.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `appointment_id` (`integer`, required): Appointment ID, from upsales_appointments_list. Example: 88.

Example input: `{"appointment_id":88}`

### `upsales_campaign_delete`

Delete Campaign · Destructive

Delete a campaign. Returns the result.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `campaign_id` (`integer`, required): Campaign ID, from upsales_campaigns_list. Example: 4.

Example input: `{"campaign_id":4}`

### `upsales_comment_delete`

Delete Comment · Destructive

Permanently delete a comment. Returns the result.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `comment_id` (`integer`, required): Comment ID, from upsales_comments_list. Example: 55.

Example input: `{"comment_id":55}`

### `upsales_company_delete`

Delete Company · Destructive

Delete a company. Returns the result.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `company_id` (`integer`, required): Company ID, from upsales_companies_list. Example: 12.

Example input: `{"company_id":12}`

### `upsales_contact_delete`

Delete Contact · Destructive

Delete a contact. Returns the result.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `contact_id` (`integer`, required): Contact ID, from upsales_contacts_list. Example: 3.

Example input: `{"contact_id":3}`

### `upsales_order_delete`

Delete Opportunity or Order · Destructive

Delete an opportunity or order. Returns the result.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `order_id` (`integer`, required): Order ID, from upsales_orders_list. Example: 900.

Example input: `{"order_id":900}`

### `upsales_product_category_delete`

Delete Product Category · Destructive

Delete a product category with no products or child categories. Returns the result; 403 when it still has products.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `product_category_id` (`integer`, required): Product category ID, from upsales_product_categories_list. Example: 2.

Example input: `{"product_category_id":2}`

### `upsales_subscription_delete`

Delete Subscription · Destructive

Delete a subscription. Returns the result. To end it instead, set its end date in Upsales.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `subscription_id` (`integer`, required): Subscription ID, from upsales_subscriptions_list. Example: 77.

Example input: `{"subscription_id":77}`

### `upsales_ticket_delete`

Delete Support Ticket · Destructive

Permanently delete a ticket and its comments. Returns the result. Move it to a closed status instead to keep history.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `ticket_id` (`integer`, required): Ticket ID, from upsales_tickets_list. Example: 400.

Example input: `{"ticket_id":400}`

## Related

Other CRM & Sales connectors ([all 174](/agentkit/connectors/?category=crm-sales)):

- [Salesforce](/agentkit/connectors/salesforce/): Scalekit connector, OAuth, 74 tools
- [HubSpot](/agentkit/connectors/hubspot/): Scalekit connector, OAuth, 457 tools
- [Close](/agentkit/connectors/close/): Scalekit connector, OAuth, 103 tools


---

## More Scalekit documentation

| Resource | What it contains | When to use it |
|----------|-----------------|----------------|
| [/llms.txt](/llms.txt) | Structured index with routing hints per product area | Start here — find which documentation set covers your topic before loading full content |
| [/llms-full.txt](/llms-full.txt) | Complete documentation for all Scalekit products in one file | Use when you need exhaustive context across multiple products or when the topic spans several areas |
| [sitemap-0.xml](https://docs.scalekit.com/sitemap-0.xml) | Full URL list of every documentation page | Use to discover specific page URLs you can fetch for targeted, page-level answers |
