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.
- Tools
- 60
- What they doRead · write · destructive
- 29 · 21 · 1029 read21 write10 destructive
- Users sign in with
- API key
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the Upsales connection
In AgentKit > Connections, create an Upsales connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Authorize a user and make your first call
quickstart.mts 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.actionsconst connector = 'upsales'const identifier = 'user_123'// Generate an authorization link for the userconst { 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 callconst result = await actions.executeTool({connector,identifier,toolName: 'upsales_activities_list',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_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.actionsconnection_name = "upsales"identifier = "user_123"# Generate an authorization link for the userlink_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 callresult = actions.execute_tool(tool_input={},tool_name="upsales_activities_list",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their Upsales credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolupsales_activities_listList activities (tasks such as phone calls and to-dos), optionally by company, user or date, with limit/offset paging.Read-onlyList Activities
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.
Inputs
close_datestring- 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_idinteger- Only activities of this company ID. Example: 2.
datestring- 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.
limitinteger- Number of records to return, up to 2000. Defaults to 1000. Example: 50.
offsetinteger- Number of records to skip, for paging. Example: 0.
sortstring- Field to sort by; prefix with - for descending, for example -regDate. Example: date.
user_idinteger- Only activities of this user ID. Example: 1.
upsales_activity_getGet one activity (phone call or to-do) by ID.Read-onlyGet Activity
Get one activity (phone call or to-do) by ID. Returns the activity.
Inputs
activity_idintegerrequired- Activity ID, from upsales_activities_list. Example: 45.
upsales_activity_types_listList the activity types (for example phone call and to-do).Read-onlyList Activity Types
List the activity types (for example phone call and to-do). Returns type IDs and names to use as activity_type_id.
Inputs
This tool takes no inputs.
upsales_appointment_types_listList the appointment types (for example first meeting, demo).Read-onlyList Appointment Types
List the appointment types (for example first meeting, demo). Returns type IDs and names to use as activity_type_id.
Inputs
This tool takes no inputs.
upsales_appointments_listList appointments (meetings), optionally by company, user or date, with limit/offset paging.Read-onlyList Appointments
List appointments (meetings), optionally by company, user or date, with limit/offset paging. Returns appointments with start and end, description, type, company and attendees.
Inputs
company_idinteger- Only appointments of this company ID. Example: 2.
datestring- 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.
limitinteger- Number of records to return, up to 2000. Defaults to 1000. Example: 50.
offsetinteger- Number of records to skip, for paging. Example: 0.
sortstring- Field to sort by; prefix with - for descending, for example -regDate. Example: date.
user_idinteger- Only appointments of this user ID. Example: 1.
upsales_campaign_getGet one campaign.Read-onlyGet Campaign
Get one campaign. Returns the campaign.
Inputs
campaign_idintegerrequired- Campaign ID, from upsales_campaigns_list. Example: 4.
upsales_campaigns_listList campaigns (called projects in the API), optionally only active ones, with limit/offset paging.Read-onlyList Campaigns
List campaigns (called projects in the API), optionally only active ones, with limit/offset paging. Returns campaign IDs, names, dates and users.
Inputs
activeinteger- 1 for active campaigns, 0 for inactive. Example: 1.one of
01 limitinteger- Number of records to return, up to 2000. Defaults to 1000. Example: 50.
offsetinteger- Number of records to skip, for paging. Example: 0.
sortstring- Field to sort by; prefix with - for descending, for example -regDate. Example: id.
upsales_comments_listList comments (notes) on companies, tickets or opportunities, with limit/offset paging.Read-onlyList Comments
List comments (notes) on companies, tickets or opportunities, with limit/offset paging. Returns comments with text, author and pinned flag.
Inputs
company_idinteger- Only comments on this company ID. Example: 12.
limitinteger- Number of records to return, up to 2000. Defaults to 1000. Example: 50.
offsetinteger- Number of records to skip, for paging. Example: 0.
opportunity_idstring- Only comments on this opportunity, for example eq:900. Example: eq:900.
sortstring- Field to sort by; prefix with - for descending, for example -regDate. Example: -regDate.
ticket_idstring- Only comments on this ticket, for example eq:400. Example: eq:400.
upsales_companies_listList companies (accounts), optionally filtered by name, responsible user or external flag, with limit/offset paging.Read-onlyList Companies
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.
Inputs
is_externalinteger- 0 for your own CRM companies, 1 for external (prospecting) ones. Example: 0.one of
01 limitinteger- Number of records to return, up to 2000. Defaults to 1000. Example: 50.
namestring- Filter by company name (exact match unless a comparison prefix is used). Example: Salesboard.
offsetinteger- Number of records to skip, for paging. Example: 0.
sortstring- Field to sort by; prefix with - for descending, for example -regDate. Example: id.
user_idinteger- Only companies with this responsible user ID. Example: 1.
upsales_company_getGet one company by ID with its contacts summary, users, categories, address and custom fields.Read-onlyGet Company
Get one company by ID with its contacts summary, users, categories, address and custom fields. Returns the company.
Inputs
company_idintegerrequired- Company ID, from upsales_companies_list. Example: 12.
upsales_contact_getGet one contact by ID with their company, phones, email and custom fields.Read-onlyGet Contact
Get one contact by ID with their company, phones, email and custom fields. Returns the contact.
Inputs
contact_idintegerrequired- Contact ID, from upsales_contacts_list. Example: 3.
upsales_contacts_listList contacts, optionally filtered by company, email or name, with limit/offset paging.Read-onlyList Contacts
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.
Inputs
company_idinteger- Only contacts of this company ID. Example: 2.
emailstring- Filter by email address. Example: erlich.bachman@piedpiper.com.
limitinteger- Number of records to return, up to 2000. Defaults to 1000. Example: 50.
namestring- Filter by full name. Example: Erlich Bachman.
offsetinteger- Number of records to skip, for paging. Example: 0.
sortstring- Field to sort by; prefix with - for descending, for example -regDate. Example: id.
upsales_custom_fields_listList the custom fields defined for one record type.Read-onlyList Custom Fields
List the custom fields defined for one record type. Returns field IDs, names and types; use the IDs as fieldId in custom values.
Inputs
entitystringrequired- Record type. Example: account.one of
accountcontactactivityappointmentorderorderrowproductprojectuseragreement
upsales_order_getGet one opportunity or order by ID with its rows, stage, probability, value and company.Read-onlyGet Opportunity or Order
Get one opportunity or order by ID with its rows, stage, probability, value and company. Returns the order.
Inputs
order_idintegerrequired- Order ID, from upsales_orders_list. Example: 900.
upsales_order_stage_getGet one opportunity or order stage.Read-onlyGet Stage
Get one opportunity or order stage. Returns the stage.
Inputs
stage_idintegerrequired- Stage ID, from upsales_order_stages_list. Example: 9.
upsales_order_stages_listList the opportunity and order stages with their probability.Read-onlyList Stages
List the opportunity and order stages with their probability. Returns stage IDs, names and probabilities.
Inputs
This tool takes no inputs.
upsales_orders_listList opportunities and orders (an order is an opportunity at 100% probability), optionally by probability, company, user, stage or date, with limit/offset paging.Read-onlyList Opportunities and Orders
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.
Inputs
company_idinteger- Only this company ID. Example: 2.
datestring- 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.
limitinteger- Number of records to return, up to 2000. Defaults to 1000. Example: 50.
offsetinteger- Number of records to skip, for paging. Example: 0.
probabilitystring- Filter by probability: 100 for won orders, 0 for lost, or a comparison such as gte:1 for open opportunities. Example: 100.
sortstring- Field to sort by; prefix with - for descending, for example -regDate. Example: -date.
stage_idinteger- Only this stage ID, from upsales_order_stages_list. Example: 9.
user_idinteger- Only this user ID. Example: 1.
upsales_price_list_getGet one price list.Read-onlyGet Price List
Get one price list. Returns the price list.
Inputs
price_list_idintegerrequired- Price list ID, from upsales_price_lists_list. Example: 1.
upsales_price_lists_listList price lists with code, active and default flags.Read-onlyList Price Lists
List price lists with code, active and default flags. Returns price list IDs.
Inputs
This tool takes no inputs.
upsales_product_categories_listList product categories with their parent category.Read-onlyList Product Categories
List product categories with their parent category. Returns category IDs and names.
Inputs
This tool takes no inputs.
upsales_product_category_getGet one product category.Read-onlyGet Product Category
Get one product category. Returns the category.
Inputs
product_category_idintegerrequired- Product category ID, from upsales_product_categories_list. Example: 2.
upsales_product_getGet one product with its prices, category and custom fields.Read-onlyGet Product
Get one product with its prices, category and custom fields. Returns the product.
Inputs
product_idintegerrequired- Product ID, from upsales_products_list. Example: 1.
use_price_listsboolean- Set to true to include prices per price list. Example: true.
upsales_products_listList 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-onlyList Products
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.
Inputs
activeinteger- 1 for active products, 0 for inactive. Example: 1.one of
01 limitinteger- Number of records to return, up to 2000. Defaults to 1000. Example: 50.
offsetinteger- Number of records to skip, for paging. Example: 0.
sortstring- Field to sort by; prefix with - for descending, for example -regDate. Example: id.
use_price_listsboolean- Set to true to include prices per price list. Example: true.
upsales_self_getGet the user and account behind the API key, with roles, currency and enabled features.Read-onlyGet Current User
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.
Inputs
This tool takes no inputs.
upsales_subscription_getGet one subscription with its rows and metadata (period, start, renewal and end dates).Read-onlyGet Subscription
Get one subscription with its rows and metadata (period, start, renewal and end dates). Returns the subscription.
Inputs
subscription_idintegerrequired- Subscription ID, from upsales_subscriptions_list. Example: 77.
upsales_subscriptions_listList subscriptions (agreements) with their recurring value, period, start and end dates and company, with limit/offset paging.Read-onlyList Subscriptions
List subscriptions (agreements) with their recurring value, period, start and end dates and company, with limit/offset paging.
Inputs
company_idinteger- Only subscriptions of this company ID. Example: 101.
limitinteger- Number of records to return, up to 2000. Defaults to 1000. Example: 50.
offsetinteger- Number of records to skip, for paging. Example: 0.
sortstring- Field to sort by; prefix with - for descending, for example -regDate. Example: id.
upsales_ticket_getGet one ticket with its comments, status, custom fields and linked records.Read-onlyGet Support Ticket
Get one ticket with its comments, status, custom fields and linked records. Returns the ticket.
Inputs
ticket_idintegerrequired- Ticket ID, from upsales_tickets_list. Example: 400.
upsales_tickets_listList support tickets, optionally by status, company, user or registration date, with limit/offset paging.Read-onlyList Support Tickets
List support tickets, optionally by status, company, user or registration date, with limit/offset paging. Returns tickets with title, status, type, priority and company.
Inputs
company_idinteger- Only tickets of this company ID. Example: 12.
limitinteger- Number of records to return, up to 2000. Defaults to 1000. Example: 50.
offsetinteger- Number of records to skip, for paging. Example: 0.
reg_datestring- 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.
sortstring- Field to sort by; prefix with - for descending, for example -regDate. Example: -regDate.
status_idstring- Filter by status ID, for example eq:3. Example: eq:1.
user_idinteger- Only tickets assigned to this user ID. Example: 8.
upsales_users_listList the users of the Upsales account.Read-onlyList Users
List the users of the Upsales account. Returns user IDs, names, emails and roles to use as user_id or user_ids.
Inputs
This tool takes no inputs.
upsales_activity_createCreate an activity such as a phone call or to-do, for users and optionally a company and contacts.WriteCreate Activity
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.
Inputs
activity_type_idintegerrequired- Activity type ID, from upsales_activity_types_list. Example: 11.
descriptionstringrequired- What the activity is about. Example: Book a meeting.
close_datestring- Date the activity was completed (YYYY-MM-DD); set it to mark the activity done. Example: 2026-02-10.
company_idinteger- Company (account) ID, from upsales_companies_list. Example: 2.
contact_idsarray- Contact IDs involved, from upsales_contacts_list. Example: [3]
datestring- Due date (YYYY-MM-DD). Example: 2026-02-10.
notesstring- Notes. Example: No answer, follow up tomorrow.
priorityinteger- Priority, 0 (none) to 3 (high). Example: 3.
user_idsarray- Upsales user IDs responsible, from upsales_users_list. Example: [1]
upsales_activity_updateUpdate an activity's description, date, notes, people or type, or mark it done with close_date.WriteUpdate Activity
Update an activity's description, date, notes, people or type, or mark it done with close_date. Returns the activity.
- Idempotent
Inputs
activity_idintegerrequired- Activity ID, from upsales_activities_list. Example: 45.
activity_type_idinteger- Activity type ID. Example: 11.
close_datestring- Date the activity was completed (YYYY-MM-DD); set it to mark the activity done. Example: 2026-02-10.
company_idinteger- Company (account) ID, from upsales_companies_list. Example: 2.
contact_idsarray- Contact IDs involved, from upsales_contacts_list. Example: [3]
datestring- Due date (YYYY-MM-DD). Example: 2026-02-10.
descriptionstring- New description. Example: Book a meeting.
notesstring- Notes. Example: No answer, follow up tomorrow.
priorityinteger- Priority, 0 (none) to 3 (high). Example: 3.
user_idsarray- Upsales user IDs responsible, from upsales_users_list. Example: [1]
upsales_appointment_createBook an appointment (meeting) with a start and end, type, users, company and contacts.WriteCreate Appointment
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.
Inputs
activity_type_idintegerrequired- Appointment type ID, from upsales_appointment_types_list. Example: 7.
datestringrequired- Start time, ISO 8601. Example: 2026-02-10T09:00:00.000Z.
is_appointmentbooleanrequired- Must be true. Example: true.
company_idinteger- Company ID, from upsales_companies_list. Example: 2.
contact_idsarray- Contact IDs involved, from upsales_contacts_list. Example: [3]
descriptionstring- Meeting subject. Example: Requirements analysis.
end_datestring- End time, ISO 8601. Example: 2026-02-10T10:00:00.000Z.
notesstring- Notes. Example: Bring the pricing deck.
user_idsarray- Upsales user IDs responsible, from upsales_users_list. Example: [1]
upsales_appointment_updateReschedule an appointment or change its description, type, attendees, company or notes.WriteUpdate Appointment
Reschedule an appointment or change its description, type, attendees, company or notes. Returns the appointment.
- Idempotent
Inputs
appointment_idintegerrequired- Appointment ID, from upsales_appointments_list. Example: 88.
activity_type_idinteger- Appointment type ID. Example: 7.
company_idinteger- Company ID, from upsales_companies_list. Example: 2.
contact_idsarray- Contact IDs involved, from upsales_contacts_list. Example: [3]
datestring- New start time, ISO 8601. Example: 2026-02-11T09:00:00.000Z.
descriptionstring- Meeting subject. Example: Requirements analysis.
end_datestring- End time, ISO 8601. Example: 2026-02-10T10:00:00.000Z.
notesstring- Notes. Example: Bring the pricing deck.
user_idsarray- Upsales user IDs responsible, from upsales_users_list. Example: [1]
upsales_campaign_createCreate a campaign with name, dates, active flag and users.WriteCreate Campaign
Create a campaign with name, dates, active flag and users. Returns the new campaign.
Inputs
namestringrequired- Campaign name. Example: Sales campaign April.
activeinteger- 1 for active, 0 to hide the campaign. Example: 1.one of
01 end_datestring- End date (YYYY-MM-DD). Example: 2026-04-30.
notesstring- Notes. Example: Spring push for SMB.
start_datestring- Start date (YYYY-MM-DD). Example: 2026-04-01.
user_idsarray- Upsales user IDs responsible, from upsales_users_list. Example: [1]
upsales_campaign_updateUpdate a campaign's name, dates, users or notes, or deactivate it with active 0.WriteUpdate Campaign
Update a campaign's name, dates, users or notes, or deactivate it with active 0. Returns the campaign.
- Idempotent
Inputs
campaign_idintegerrequired- Campaign ID, from upsales_campaigns_list. Example: 4.
activeinteger- 1 for active, 0 to hide the campaign. Example: 1.one of
01 end_datestring- End date (YYYY-MM-DD). Example: 2026-04-30.
namestring- New name. Example: Sales campaign April.
notesstring- Notes. Example: Spring push for SMB.
start_datestring- Start date (YYYY-MM-DD). Example: 2026-04-01.
user_idsarray- Upsales user IDs responsible, from upsales_users_list. Example: [1]
upsales_comment_createAdd a comment (note) to a company, contact, opportunity or ticket.WriteCreate Comment
Add a comment (note) to a company, contact, opportunity or ticket. Returns the new comment.
Inputs
descriptionstringrequired- Comment text. Example: Renewal conversation started, decision expected in Q3.
user_idintegerrequired- Author user ID, from upsales_users_list. Example: 5.
company_idinteger- Company ID to attach to. Example: 12.
contact_idinteger- Contact ID to attach to. Example: 340.
is_pinnedboolean- Set to true to pin the comment. Example: false.
opportunity_idinteger- Opportunity ID to attach to. Example: 900.
ticket_idinteger- Ticket ID to attach to. Example: 400.
upsales_comment_updateEdit a comment's text or pin it.WriteUpdate Comment
Edit a comment's text or pin it. Returns the comment. A comment cannot be moved to another record.
- Idempotent
Inputs
comment_idintegerrequired- Comment ID, from upsales_comments_list. Example: 55.
descriptionstring- New text. Example: Renewal signed 12 June.
is_pinnedboolean- Set to true to pin, false to unpin. Example: true.
upsales_company_createCreate a company (account) with name, phone, website, responsible users and custom fields.WriteCreate Company
Create a company (account) with name, phone, website, responsible users and custom fields. Returns the new company.
Inputs
namestringrequired- Company name. Example: Salesboard.
customarray- Custom field values, each {"fieldId": <id>, "value": <value>}; field IDs from upsales_custom_fields_list. Example: [{"fieldId": 3, "value": "2210"}]
notesstring- Notes about the company. Example: Key account since 2024.
phonestring- Main phone number. Example: +46 8 123 456.
user_idsarray- Upsales user IDs responsible, from upsales_users_list. Example: [1]
webpagestring- Website URL. Example: https://salesboard.com.
upsales_company_updateUpdate a company's name, phone, website, notes, responsible users or custom fields; fields left empty are unchanged.WriteUpdate Company
Update a company's name, phone, website, notes, responsible users or custom fields; fields left empty are unchanged. Returns the company.
- Idempotent
Inputs
company_idintegerrequired- Company ID, from upsales_companies_list. Example: 12.
customarray- Custom field values, each {"fieldId": <id>, "value": <value>}; field IDs from upsales_custom_fields_list. Example: [{"fieldId": 3, "value": "2210"}]
namestring- New company name. Example: Salesboard AB.
notesstring- Notes about the company. Example: Key account since 2024.
phonestring- Main phone number. Example: +46 8 123 456.
user_idsarray- Upsales user IDs responsible, from upsales_users_list. Example: [1]
webpagestring- Website URL. Example: https://salesboard.com.
upsales_contact_createCreate a contact with first and last name, phones, email, title and company.WriteCreate Contact
Create a contact with first and last name, phones, email, title and company. Returns the new contact.
Inputs
first_namestringrequired- First name. Example: Erlich.
activeinteger- 1 for active, 0 for inactive. Example: 1.one of
01 cell_phonestring- Mobile phone number. Example: 0732231312.
company_idinteger- Company (account) ID, from upsales_companies_list. Example: 2.
customarray- Custom field values, each {"fieldId": <id>, "value": <value>}; field IDs from upsales_custom_fields_list. Example: [{"fieldId": 3, "value": "2210"}]
emailstring- Email address. Example: erlich.bachman@piedpiper.com.
last_namestring- Last name. Example: Bachman.
phonestring- Phone number. Example: 08-860 804 04.
titlestring- Job title. Example: Software designer.
upsales_contact_updateUpdate a contact's name, phones, email, title, company or active flag; fields left empty are unchanged.WriteUpdate Contact
Update a contact's name, phones, email, title, company or active flag; fields left empty are unchanged. Returns the contact.
- Idempotent
Inputs
contact_idintegerrequired- Contact ID, from upsales_contacts_list. Example: 3.
activeinteger- 1 for active, 0 for inactive. Example: 1.one of
01 cell_phonestring- Mobile phone number. Example: 0732231312.
company_idinteger- Company (account) ID, from upsales_companies_list. Example: 2.
customarray- Custom field values, each {"fieldId": <id>, "value": <value>}; field IDs from upsales_custom_fields_list. Example: [{"fieldId": 3, "value": "2210"}]
emailstring- Email address. Example: erlich.bachman@piedpiper.com.
first_namestring- New first name. Example: Erlich.
last_namestring- New last name. Example: Bachman.
phonestring- Phone number. Example: 08-860 804 04.
titlestring- Job title. Example: Software designer.
upsales_order_createCreate an opportunity (probability below 100) or a won order (probability 100) for a company with stage, user, close date and product rows.WriteCreate Opportunity or Order
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.
Inputs
company_idintegerrequired- Company ID, from upsales_companies_list. Example: 2.
descriptionstringrequired- Description. Example: 10 licenses.
stage_idintegerrequired- Stage ID, from upsales_order_stages_list. Example: 9.
campaign_idinteger- Campaign ID, from upsales_campaigns_list. Example: 4.
currencystring- Currency code; defaults to the master currency. Example: SEK.
customarray- Custom field values, each {"fieldId": <id>, "value": <value>}; field IDs from upsales_custom_fields_list. Example: [{"fieldId": 3, "value": "2210"}]
datestring- Expected or actual close date (YYYY-MM-DD). Example: 2026-03-31.
notesstring- Notes. Example: Decision expected in March.
order_rowsarray- Rows, each {quantity, price, listPrice, purchaseCost, product: {id}}; product IDs from upsales_products_list. Example: [{"quantity": 1, "price": 9000, "listPrice": 10000, "product": {"id": 1}}]
probabilityinteger- Probability 0 to 100; 100 makes it an order. Example: 25.
user_idinteger- Responsible user ID. Example: 1.
upsales_order_updateUpdate an opportunity or order: stage, probability, close date, rows, user or notes.WriteUpdate Opportunity or Order
Update an opportunity or order: stage, probability, close date, rows, user or notes. Sending order_rows replaces the rows. Returns the order.
- Idempotent
Inputs
order_idintegerrequired- Order ID, from upsales_orders_list. Example: 900.
campaign_idinteger- Campaign ID, from upsales_campaigns_list. Example: 4.
company_idinteger- Company ID. Example: 2.
currencystring- Currency code; defaults to the master currency. Example: SEK.
customarray- Custom field values, each {"fieldId": <id>, "value": <value>}; field IDs from upsales_custom_fields_list. Example: [{"fieldId": 3, "value": "2210"}]
datestring- Expected or actual close date (YYYY-MM-DD). Example: 2026-03-31.
descriptionstring- New description. Example: 12 licenses.
notesstring- Notes. Example: Decision expected in March.
order_rowsarray- Rows, each {quantity, price, listPrice, purchaseCost, product: {id}}; product IDs from upsales_products_list. Example: [{"quantity": 1, "price": 9000, "listPrice": 10000, "product": {"id": 1}}]
probabilityinteger- Probability 0 to 100; 100 makes it an order. Example: 25.
stage_idinteger- Stage ID. Example: 10.
user_idinteger- Responsible user ID. Example: 1.
upsales_product_category_createCreate a product category, optionally under a parent.WriteCreate Product Category
Create a product category, optionally under a parent. Returns the new category.
Inputs
namestringrequired- Category name. Example: One-off products.
parent_idinteger- Parent category ID. Example: 1.
upsales_product_category_updateRename a product category or move it under another parent.WriteUpdate Product Category
Rename a product category or move it under another parent. Returns the category.
- Idempotent
Inputs
product_category_idintegerrequired- Product category ID, from upsales_product_categories_list. Example: 2.
namestring- New name. Example: Services.
parent_idinteger- New parent category ID. Example: 1.
upsales_product_createCreate a product with name, list price, category and active flag.WriteCreate Product
Create a product with name, list price, category and active flag. Returns the new product.
Inputs
list_pricenumberrequired- List price. Example: 20000.
namestringrequired- Product name. Example: SaaS product.
activeinteger- 1 for active, 0 to disable the product (products cannot be deleted). Example: 1.one of
01 category_idinteger- Product category ID, from upsales_product_categories_list. Example: 2.
customarray- Custom field values, each {"fieldId": <id>, "value": <value>}; field IDs from upsales_custom_fields_list. Example: [{"fieldId": 3, "value": "2210"}]
is_recurringinteger- 1 for a subscription product. Example: 1.one of
01 purchase_costnumber- Purchase cost. Example: 4500.
upsales_product_updateUpdate a product's name, price, category or cost, or disable it with active 0.WriteUpdate Product
Update a product's name, price, category or cost, or disable it with active 0. Returns the product.
- Idempotent
Inputs
product_idintegerrequired- Product ID, from upsales_products_list. Example: 1.
activeinteger- 1 for active, 0 to disable the product (products cannot be deleted). Example: 1.one of
01 category_idinteger- Product category ID, from upsales_product_categories_list. Example: 2.
customarray- Custom field values, each {"fieldId": <id>, "value": <value>}; field IDs from upsales_custom_fields_list. Example: [{"fieldId": 3, "value": "2210"}]
is_recurringinteger- 1 for a subscription product. Example: 1.one of
01 list_pricenumber- New list price. Example: 30000.
namestring- New name. Example: SaaS product.
purchase_costnumber- Purchase cost. Example: 4500.
upsales_ticket_comment_addAdd a reply to a ticket; public comments are emailed to the customer, private ones are internal notes.WriteAdd Ticket Comment
Add a reply to a ticket; public comments are emailed to the customer, private ones are internal notes. Returns the comment.
Inputs
descriptionstringrequired- Comment text. Example: We have reset the account, please try again.
is_publicbooleanrequired- true sends it to the customer, false keeps it internal. Example: false.
ticket_idintegerrequired- Ticket ID, from upsales_tickets_list. Example: 400.
user_idinteger- User ID of the author. Example: 8.
upsales_ticket_createCreate a support ticket with title, status and type, optionally for a company and contact and assigned to a user.WriteCreate Support Ticket
Create a support ticket with title, status and type, optionally for a company and contact and assigned to a user. Returns the new ticket.
Inputs
status_idintegerrequired- Ticket status ID that exists on the account. Example: 1.
titlestringrequired- Ticket title. Example: Cannot log in to the mobile app.
type_idintegerrequired- Ticket type ID that exists on the account. Example: 1.
company_idinteger- Company ID. Example: 12.
contact_idinteger- Contact ID of the requester. Example: 340.
customarray- Custom field values, each {"fieldId": <id>, "value": <value>}; field IDs from upsales_custom_fields_list. Example: [{"fieldId": 3, "value": "2210"}]
priorityinteger- Priority, 0 (none) to 3 (urgent). Example: 2.
user_idinteger- Assigned user ID (needs a support licence). Example: 5.
upsales_ticket_updateReassign a ticket, change its status, type, priority or title.WriteUpdate Support Ticket
Reassign a ticket, change its status, type, priority or title. Returns the ticket.
- Idempotent
Inputs
ticket_idintegerrequired- Ticket ID, from upsales_tickets_list. Example: 400.
company_idinteger- Company ID. Example: 12.
contact_idinteger- Contact ID of the requester. Example: 340.
customarray- Custom field values, each {"fieldId": <id>, "value": <value>}; field IDs from upsales_custom_fields_list. Example: [{"fieldId": 3, "value": "2210"}]
priorityinteger- Priority, 0 (none) to 3 (urgent). Example: 2.
status_idinteger- New status ID. Example: 3.
titlestring- New title. Example: Cannot log in to the iOS app.
type_idinteger- New type ID. Example: 1.
user_idinteger- Assigned user ID (needs a support licence). Example: 5.
upsales_activity_deleteDelete an activity.DestructiveDelete Activity
Delete an activity. Returns the result.
- Idempotent
Inputs
activity_idintegerrequired- Activity ID, from upsales_activities_list. Example: 45.
upsales_appointment_deleteDelete an appointment.DestructiveDelete Appointment
Delete an appointment. Returns the result.
- Idempotent
Inputs
appointment_idintegerrequired- Appointment ID, from upsales_appointments_list. Example: 88.
upsales_campaign_deleteDelete a campaign.DestructiveDelete Campaign
Delete a campaign. Returns the result.
- Idempotent
Inputs
campaign_idintegerrequired- Campaign ID, from upsales_campaigns_list. Example: 4.
upsales_comment_deletePermanently delete a comment.DestructiveDelete Comment
Permanently delete a comment. Returns the result.
- Idempotent
Inputs
comment_idintegerrequired- Comment ID, from upsales_comments_list. Example: 55.
upsales_company_deleteDelete a company.DestructiveDelete Company
Delete a company. Returns the result.
- Idempotent
Inputs
company_idintegerrequired- Company ID, from upsales_companies_list. Example: 12.
upsales_contact_deleteDelete a contact.DestructiveDelete Contact
Delete a contact. Returns the result.
- Idempotent
Inputs
contact_idintegerrequired- Contact ID, from upsales_contacts_list. Example: 3.
upsales_order_deleteDelete an opportunity or order.DestructiveDelete Opportunity or Order
Delete an opportunity or order. Returns the result.
- Idempotent
Inputs
order_idintegerrequired- Order ID, from upsales_orders_list. Example: 900.
upsales_product_category_deleteDelete a product category with no products or child categories.DestructiveDelete Product Category
Delete a product category with no products or child categories. Returns the result; 403 when it still has products.
- Idempotent
Inputs
product_category_idintegerrequired- Product category ID, from upsales_product_categories_list. Example: 2.
upsales_subscription_deleteDelete a subscription.DestructiveDelete Subscription
Delete a subscription. Returns the result. To end it instead, set its end date in Upsales.
- Idempotent
Inputs
subscription_idintegerrequired- Subscription ID, from upsales_subscriptions_list. Example: 77.
upsales_ticket_deletePermanently delete a ticket and its comments.DestructiveDelete Support Ticket
Permanently delete a ticket and its comments. Returns the result. Move it to a closed status instead to keep history.
- Idempotent
Inputs
ticket_idintegerrequired- Ticket ID, from upsales_tickets_list. Example: 400.
No tools match.