Salesforce
The most straightforward way to access the Salesforce API for your team.
Overview
The Stacksync Salesforce API Proxy provides secure, streamlined access to the Salesforce APIs without requiring you to manage Connected Apps, OAuth flows, or API-specific quirks. Once configured, you can perform common Salesforce operations (insert, update, upsert, delete, query, and metadata access) through a single, consistent HTTPS endpoint using your Stacksync service token.
Operations:
Upsert records (tries to update a record and inserts it if it is not found)
Insert
Insert up to 10,000 records in a single request. You provide the field values for each record, and the API Proxy returns a per-record result indicating success or failure.
Example response body:
Upsert
Create or update a single Salesforce record in an idempotent way, based on a matching key. The match_key can be the record Id or any other field you designate as a unique identifier.
If the key does not match an existing record, a new record is created. If it matches exactly one record, that record is updated. If it matches multiple records, the operation fails to avoid ambiguous updates.
Use this operation when you want to safely handle “create‑or‑update” logic without building separate lookup and write steps.
Example response body:
Update
Modify existing Salesforce records in bulk. This operation lets you update up to 10,000 records per request and overwrites the specified fields with the new values you provide.
It is designed for controlled bulk changes, such as correcting attributes, updating ownership, or propagating new values from another system, with per‑record success and error reporting.
Example response body:
Delete
Remove Salesforce records in bulk by their Ids. This endpoint allows you to delete up to 10,000 records per request and returns a result for each Id indicating whether the delete succeeded or failed.
Use this operation for operational clean‑up, testing environments, and data hygiene tasks, where you need auditable, large‑scale deletions via a single, secure API call.
Example response body:
Get
Retrieve full or partial representations of Salesforce records by Id. You can request up to 10,000 records in a single call and optionally specify the list of fields to return.
If no fields are provided, all fields available to the connected Salesforce user are returned. This operation is ideal when you need record‑level detail for downstream processing, enrichment, or troubleshooting.
Example response body:
SOQL
Execute a SOQL (Salesforce Object Query Language) query against your Salesforce instance through the Stacksync API Proxy. SOQL lets you select specific fields from one or more Salesforce objects, filter records with conditions, and control ordering and limits, similar to how you would use SQL against a relational database.
Use this operation when you need to:
Power reports, dashboards, or internal tools that read Salesforce data on demand or low-volume, otherwise using Stacksync Syncs is recommended.
Retrieve targeted subsets of data (for example, “all open Opportunities over a certain amount”) without loading full objects.
Implement application logic that depends on Salesforce state, such as routing, enrichment, or eligibility checks.
You provide the SOQL query string, and the API Proxy executes it using the managed Salesforce connection and returns the query results in a standard JSON format. [
Describe Salesforce Instance
Retrieve metadata about your Salesforce instance, including the list of available objects and their high‑level characteristics.
This operation is useful for discovery and tooling scenarios, such as generating config, inspecting available objects before building integrations, or validating that required objects exist in a given org.
Describe Object
Retrieve detailed metadata for a specific Salesforce object, including field definitions and attributes.
Use this operation when you need to understand the structure of an object (such as required fields, data types, and constraints) before building or adjusting integrations and data flows.
Add a custom field to a Salesforce object
Add a custom field to a Salesforce object. Standard and custom objects are supported.
This operation is suited for automated provisioning and configuration, where you want infrastructure or integration pipelines to manage Salesforce schema changes in a controlled, repeatable way.
The required request body parameters are:
typethe type of the custom field you wish to createnamethe name of the custom field you wish to createlabelthe label associated to the custom field you wish to create
type can be any of the field types presented here
Unless otherwise noted, all fields are creatable, filterable, and nullable.
Some optional parameters may be required depending on the type,
(eg: length is required when creating a custom field of type Text)
Learn more about the API behavior here.
Example Response Body:
Example requests for different field types:
Example:
Pass Through
Invoke any Salesforce REST API endpoint via the Stacksync API Proxy. You provide the full Salesforce URL, HTTP method, and optional request body, and the proxy forwards the request using the managed Salesforce connection.
Use this operation when you need capabilities that are not yet covered by the higher‑level endpoints (insert, update, delete, etc.), while still benefiting from centralized authentication, logging, and access control.
Example request:
Get Account Record
Example response:
Get Country List
Retrieves the list of countries configured in your Salesforce org's Address Settings. This is useful for populating country dropdowns or validating country data in your application.
Example response:
Last updated