Salesforce
API actions for the Salesforce integration.
Salesforce
Sync Salesforce CRM by creating leads, accounts, and opportunities with API tokens.
Create Salesforce account
Create a new Salesforce account.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Account name |
industry | string | No | Industry |
website | string | No | Website URL |
Response
{
"errors": [],
"id": "001xx000003DGbXAAW",
"success": true
}Create Salesforce lead
Create a lead with contact details and company information.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
email | string | Yes | Lead email |
last_name | string | Yes | Lead last name |
company | string | Yes | Lead company |
first_name | string | No | Lead first name |
phone | string | No | Phone number |
title | string | No | Lead title |
Response
{
"errors": [],
"id": "00Qxx0000001234",
"success": true
}Create Salesforce opportunity
Create a new Salesforce opportunity.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Opportunity name |
account_id | string | No | Associated account ID |
stage_name | string | Yes | Sales stage name |
close_date | string | Yes | Close date (YYYY-MM-DD) |
amount | number | No | Opportunity amount |
Response
{
"errors": [],
"id": "006xx000004TGpUAAW",
"success": true
}Get Salesforce lead
Retrieve a Salesforce lead by ID.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
lead_id | string | Yes | Lead ID |
Response
{
"Company": "Example Co",
"Email": "alex.lee@example.com",
"FirstName": "Alex",
"Id": "00Qxx0000001234",
"LastName": "Lee"
}List Salesforce leads
List Salesforce leads with a limit.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
limit | number | No | Maximum number of leads to return |
Response
[
{
"Email": "alex.lee@example.com",
"FirstName": "Alex",
"Id": "00Qxx0000001234",
"LastName": "Lee"
}
]Update Salesforce account
Update fields for an existing Salesforce account.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
account_id | string | Yes | Salesforce account ID |
updates | object | Yes | JSON object of fields to update |
Response
{
"errors": [],
"id": "001xx000003DGbXAAW",
"success": true
}Update Salesforce lead
Update fields for an existing Salesforce lead.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
lead_id | string | Yes | Salesforce lead ID |
updates | object | Yes | JSON object of fields to update |
Response
{
"errors": [],
"id": "00Qxx0000001234",
"success": true
}Update opportunity stage
Update the sales stage of a Salesforce opportunity.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
opportunity_id | string | Yes | Opportunity ID |
stage_name | string | Yes | New stage name |
Response
{
"errors": [],
"id": "006xx000004TGpUAAW",
"success": true
}