(crm.leads)
List leads
import { Apideck } from "@apideck/unify";
const apideck = new Apideck({
apiKey: process.env["APIDECK_API_KEY"] ?? "",
consumerId: "test-consumer",
appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
});
async function run() {
const result = await apideck.crm.leads.list({
serviceId: "salesforce",
filter: {
name: "Elon Musk",
firstName: "Elon",
lastName: "Musk",
email: "elon@tesla.com",
phoneNumber: "1234567890",
},
sort: {
by: "created_at",
direction: "desc",
},
passThrough: {
"search": "San Francisco",
},
fields: "id,updated_at",
});
for await (const page of result) {
// Handle the page
console.log(page);
}
}
run();The standalone function version of this method:
import { ApideckCore } from "@apideck/unify/core.js";
import { crmLeadsList } from "@apideck/unify/funcs/crmLeadsList.js";
// Use `ApideckCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const apideck = new ApideckCore({
apiKey: process.env["APIDECK_API_KEY"] ?? "",
consumerId: "test-consumer",
appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
});
async function run() {
const res = await crmLeadsList(apideck, {
serviceId: "salesforce",
filter: {
name: "Elon Musk",
firstName: "Elon",
lastName: "Musk",
email: "elon@tesla.com",
phoneNumber: "1234567890",
},
sort: {
by: "created_at",
direction: "desc",
},
passThrough: {
"search": "San Francisco",
},
fields: "id,updated_at",
});
if (!res.ok) {
throw res.error;
}
const { value: result } = res;
for await (const page of result) {
// Handle the page
console.log(page);
}
}
run();| Parameter | Type | Required | Description |
|---|---|---|---|
request |
operations.CrmLeadsAllRequest | ✔️ | The request object to use for the request. |
options |
RequestOptions | ➖ | Used to set various options for making HTTP requests. |
options.fetchOptions |
RequestInit | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed. |
options.retries |
RetryConfig | ➖ | Enables retrying HTTP requests under certain failure conditions. |
Promise<operations.CrmLeadsAllResponse>
| Error Type | Status Code | Content Type |
|---|---|---|
| errors.BadRequestResponse | 400 | application/json |
| errors.UnauthorizedResponse | 401 | application/json |
| errors.PaymentRequiredResponse | 402 | application/json |
| errors.NotFoundResponse | 404 | application/json |
| errors.UnprocessableResponse | 422 | application/json |
| errors.APIError | 4XX, 5XX | */* |
Create lead
import { Apideck } from "@apideck/unify";
const apideck = new Apideck({
apiKey: process.env["APIDECK_API_KEY"] ?? "",
consumerId: "test-consumer",
appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
});
async function run() {
const result = await apideck.crm.leads.create({
serviceId: "salesforce",
lead: {
name: "Elon Musk",
companyName: "Spacex",
ownerId: "54321",
ownerName: "John Doe",
companyId: "2",
leadId: "2",
leadSource: "Cold Call",
firstName: "Elon",
lastName: "Musk",
description: "A thinker",
prefix: "Sir",
title: "CEO",
language: "EN",
status: "New",
monetaryAmount: 75000,
currency: "USD",
fax: "+12129876543",
websites: [
{
id: "12345",
url: "http://example.com",
type: "primary",
},
],
addresses: [
{
id: "123",
type: "primary",
string: "25 Spring Street, Blackburn, VIC 3130",
name: "HQ US",
line1: "Main street",
line2: "apt #",
line3: "Suite #",
line4: "delivery instructions",
streetNumber: "25",
city: "San Francisco",
state: "CA",
postalCode: "94104",
country: "US",
latitude: "40.759211",
longitude: "-73.984638",
county: "Santa Clara",
contactName: "Elon Musk",
salutation: "Mr",
phoneNumber: "111-111-1111",
fax: "122-111-1111",
email: "elon@musk.com",
website: "https://elonmusk.com",
notes: "Address notes or delivery instructions.",
rowVersion: "1-12345",
},
{
id: "123",
type: "primary",
string: "25 Spring Street, Blackburn, VIC 3130",
name: "HQ US",
line1: "Main street",
line2: "apt #",
line3: "Suite #",
line4: "delivery instructions",
streetNumber: "25",
city: "San Francisco",
state: "CA",
postalCode: "94104",
country: "US",
latitude: "40.759211",
longitude: "-73.984638",
county: "Santa Clara",
contactName: "Elon Musk",
salutation: "Mr",
phoneNumber: "111-111-1111",
fax: "122-111-1111",
email: "elon@musk.com",
website: "https://elonmusk.com",
notes: "Address notes or delivery instructions.",
rowVersion: "1-12345",
},
],
socialLinks: [
{
id: "12345",
url: "https://www.twitter.com/apideck",
type: "twitter",
},
{
id: "12345",
url: "https://www.twitter.com/apideck",
type: "twitter",
},
],
phoneNumbers: [
{
id: "12345",
countryCode: "1",
areaCode: "323",
number: "111-111-1111",
extension: "105",
type: "primary",
},
{
id: "12345",
countryCode: "1",
areaCode: "323",
number: "111-111-1111",
extension: "105",
type: "primary",
},
],
emails: [
{
id: "123",
email: "elon@musk.com",
type: "primary",
},
{
id: "123",
email: "elon@musk.com",
type: "primary",
},
{
id: "123",
email: "elon@musk.com",
type: "primary",
},
],
customFields: [
{
id: "2389328923893298",
name: "employee_level",
description: "Employee Level",
value: true,
},
],
tags: [
"New",
],
passThrough: [
{
serviceId: "<id>",
extendPaths: [
{
path: "$.nested.property",
value: {
"TaxClassificationRef": {
"value": "EUC-99990201-V1-00020000",
},
},
},
{
path: "$.nested.property",
value: {
"TaxClassificationRef": {
"value": "EUC-99990201-V1-00020000",
},
},
},
{
path: "$.nested.property",
value: {
"TaxClassificationRef": {
"value": "EUC-99990201-V1-00020000",
},
},
},
],
},
],
},
});
// Handle the result
console.log(result);
}
run();The standalone function version of this method:
import { ApideckCore } from "@apideck/unify/core.js";
import { crmLeadsCreate } from "@apideck/unify/funcs/crmLeadsCreate.js";
// Use `ApideckCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const apideck = new ApideckCore({
apiKey: process.env["APIDECK_API_KEY"] ?? "",
consumerId: "test-consumer",
appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
});
async function run() {
const res = await crmLeadsCreate(apideck, {
serviceId: "salesforce",
lead: {
name: "Elon Musk",
companyName: "Spacex",
ownerId: "54321",
ownerName: "John Doe",
companyId: "2",
leadId: "2",
leadSource: "Cold Call",
firstName: "Elon",
lastName: "Musk",
description: "A thinker",
prefix: "Sir",
title: "CEO",
language: "EN",
status: "New",
monetaryAmount: 75000,
currency: "USD",
fax: "+12129876543",
websites: [
{
id: "12345",
url: "http://example.com",
type: "primary",
},
],
addresses: [
{
id: "123",
type: "primary",
string: "25 Spring Street, Blackburn, VIC 3130",
name: "HQ US",
line1: "Main street",
line2: "apt #",
line3: "Suite #",
line4: "delivery instructions",
streetNumber: "25",
city: "San Francisco",
state: "CA",
postalCode: "94104",
country: "US",
latitude: "40.759211",
longitude: "-73.984638",
county: "Santa Clara",
contactName: "Elon Musk",
salutation: "Mr",
phoneNumber: "111-111-1111",
fax: "122-111-1111",
email: "elon@musk.com",
website: "https://elonmusk.com",
notes: "Address notes or delivery instructions.",
rowVersion: "1-12345",
},
{
id: "123",
type: "primary",
string: "25 Spring Street, Blackburn, VIC 3130",
name: "HQ US",
line1: "Main street",
line2: "apt #",
line3: "Suite #",
line4: "delivery instructions",
streetNumber: "25",
city: "San Francisco",
state: "CA",
postalCode: "94104",
country: "US",
latitude: "40.759211",
longitude: "-73.984638",
county: "Santa Clara",
contactName: "Elon Musk",
salutation: "Mr",
phoneNumber: "111-111-1111",
fax: "122-111-1111",
email: "elon@musk.com",
website: "https://elonmusk.com",
notes: "Address notes or delivery instructions.",
rowVersion: "1-12345",
},
],
socialLinks: [
{
id: "12345",
url: "https://www.twitter.com/apideck",
type: "twitter",
},
{
id: "12345",
url: "https://www.twitter.com/apideck",
type: "twitter",
},
],
phoneNumbers: [
{
id: "12345",
countryCode: "1",
areaCode: "323",
number: "111-111-1111",
extension: "105",
type: "primary",
},
{
id: "12345",
countryCode: "1",
areaCode: "323",
number: "111-111-1111",
extension: "105",
type: "primary",
},
],
emails: [
{
id: "123",
email: "elon@musk.com",
type: "primary",
},
{
id: "123",
email: "elon@musk.com",
type: "primary",
},
{
id: "123",
email: "elon@musk.com",
type: "primary",
},
],
customFields: [
{
id: "2389328923893298",
name: "employee_level",
description: "Employee Level",
value: true,
},
],
tags: [
"New",
],
passThrough: [
{
serviceId: "<id>",
extendPaths: [
{
path: "$.nested.property",
value: {
"TaxClassificationRef": {
"value": "EUC-99990201-V1-00020000",
},
},
},
{
path: "$.nested.property",
value: {
"TaxClassificationRef": {
"value": "EUC-99990201-V1-00020000",
},
},
},
{
path: "$.nested.property",
value: {
"TaxClassificationRef": {
"value": "EUC-99990201-V1-00020000",
},
},
},
],
},
],
},
});
if (!res.ok) {
throw res.error;
}
const { value: result } = res;
// Handle the result
console.log(result);
}
run();| Parameter | Type | Required | Description |
|---|---|---|---|
request |
operations.CrmLeadsAddRequest | ✔️ | The request object to use for the request. |
options |
RequestOptions | ➖ | Used to set various options for making HTTP requests. |
options.fetchOptions |
RequestInit | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed. |
options.retries |
RetryConfig | ➖ | Enables retrying HTTP requests under certain failure conditions. |
Promise<operations.CrmLeadsAddResponse>
| Error Type | Status Code | Content Type |
|---|---|---|
| errors.BadRequestResponse | 400 | application/json |
| errors.UnauthorizedResponse | 401 | application/json |
| errors.PaymentRequiredResponse | 402 | application/json |
| errors.NotFoundResponse | 404 | application/json |
| errors.UnprocessableResponse | 422 | application/json |
| errors.APIError | 4XX, 5XX | */* |
Get lead
import { Apideck } from "@apideck/unify";
const apideck = new Apideck({
apiKey: process.env["APIDECK_API_KEY"] ?? "",
consumerId: "test-consumer",
appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
});
async function run() {
const result = await apideck.crm.leads.get({
id: "<id>",
serviceId: "salesforce",
fields: "id,updated_at",
});
// Handle the result
console.log(result);
}
run();The standalone function version of this method:
import { ApideckCore } from "@apideck/unify/core.js";
import { crmLeadsGet } from "@apideck/unify/funcs/crmLeadsGet.js";
// Use `ApideckCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const apideck = new ApideckCore({
apiKey: process.env["APIDECK_API_KEY"] ?? "",
consumerId: "test-consumer",
appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
});
async function run() {
const res = await crmLeadsGet(apideck, {
id: "<id>",
serviceId: "salesforce",
fields: "id,updated_at",
});
if (!res.ok) {
throw res.error;
}
const { value: result } = res;
// Handle the result
console.log(result);
}
run();| Parameter | Type | Required | Description |
|---|---|---|---|
request |
operations.CrmLeadsOneRequest | ✔️ | The request object to use for the request. |
options |
RequestOptions | ➖ | Used to set various options for making HTTP requests. |
options.fetchOptions |
RequestInit | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed. |
options.retries |
RetryConfig | ➖ | Enables retrying HTTP requests under certain failure conditions. |
Promise<operations.CrmLeadsOneResponse>
| Error Type | Status Code | Content Type |
|---|---|---|
| errors.BadRequestResponse | 400 | application/json |
| errors.UnauthorizedResponse | 401 | application/json |
| errors.PaymentRequiredResponse | 402 | application/json |
| errors.NotFoundResponse | 404 | application/json |
| errors.UnprocessableResponse | 422 | application/json |
| errors.APIError | 4XX, 5XX | */* |
Update lead
import { Apideck } from "@apideck/unify";
const apideck = new Apideck({
apiKey: process.env["APIDECK_API_KEY"] ?? "",
consumerId: "test-consumer",
appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
});
async function run() {
const result = await apideck.crm.leads.update({
id: "<id>",
serviceId: "salesforce",
lead: {
name: "Elon Musk",
companyName: "Spacex",
ownerId: "54321",
ownerName: "John Doe",
companyId: "2",
leadId: "2",
leadSource: "Cold Call",
firstName: "Elon",
lastName: "Musk",
description: "A thinker",
prefix: "Sir",
title: "CEO",
language: "EN",
status: "New",
monetaryAmount: 75000,
currency: "USD",
fax: "+12129876543",
websites: [
{
id: "12345",
url: "http://example.com",
type: "primary",
},
{
id: "12345",
url: "http://example.com",
type: "primary",
},
],
addresses: [
{
id: "123",
type: "primary",
string: "25 Spring Street, Blackburn, VIC 3130",
name: "HQ US",
line1: "Main street",
line2: "apt #",
line3: "Suite #",
line4: "delivery instructions",
streetNumber: "25",
city: "San Francisco",
state: "CA",
postalCode: "94104",
country: "US",
latitude: "40.759211",
longitude: "-73.984638",
county: "Santa Clara",
contactName: "Elon Musk",
salutation: "Mr",
phoneNumber: "111-111-1111",
fax: "122-111-1111",
email: "elon@musk.com",
website: "https://elonmusk.com",
notes: "Address notes or delivery instructions.",
rowVersion: "1-12345",
},
],
socialLinks: [
{
id: "12345",
url: "https://www.twitter.com/apideck",
type: "twitter",
},
{
id: "12345",
url: "https://www.twitter.com/apideck",
type: "twitter",
},
{
id: "12345",
url: "https://www.twitter.com/apideck",
type: "twitter",
},
],
phoneNumbers: [
{
id: "12345",
countryCode: "1",
areaCode: "323",
number: "111-111-1111",
extension: "105",
type: "primary",
},
{
id: "12345",
countryCode: "1",
areaCode: "323",
number: "111-111-1111",
extension: "105",
type: "primary",
},
{
id: "12345",
countryCode: "1",
areaCode: "323",
number: "111-111-1111",
extension: "105",
type: "primary",
},
],
emails: [
{
id: "123",
email: "elon@musk.com",
type: "primary",
},
],
customFields: [
{
id: "2389328923893298",
name: "employee_level",
description: "Employee Level",
value: "Uses Salesforce and Marketo",
},
{
id: "2389328923893298",
name: "employee_level",
description: "Employee Level",
value: 10,
},
{
id: "2389328923893298",
name: "employee_level",
description: "Employee Level",
value: [
"<value>",
"<value>",
],
},
],
tags: [
"New",
],
passThrough: [
{
serviceId: "<id>",
extendPaths: [
{
path: "$.nested.property",
value: {
"TaxClassificationRef": {
"value": "EUC-99990201-V1-00020000",
},
},
},
{
path: "$.nested.property",
value: {
"TaxClassificationRef": {
"value": "EUC-99990201-V1-00020000",
},
},
},
],
},
{
serviceId: "<id>",
extendPaths: [
{
path: "$.nested.property",
value: {
"TaxClassificationRef": {
"value": "EUC-99990201-V1-00020000",
},
},
},
],
},
],
},
});
// Handle the result
console.log(result);
}
run();The standalone function version of this method:
import { ApideckCore } from "@apideck/unify/core.js";
import { crmLeadsUpdate } from "@apideck/unify/funcs/crmLeadsUpdate.js";
// Use `ApideckCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const apideck = new ApideckCore({
apiKey: process.env["APIDECK_API_KEY"] ?? "",
consumerId: "test-consumer",
appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
});
async function run() {
const res = await crmLeadsUpdate(apideck, {
id: "<id>",
serviceId: "salesforce",
lead: {
name: "Elon Musk",
companyName: "Spacex",
ownerId: "54321",
ownerName: "John Doe",
companyId: "2",
leadId: "2",
leadSource: "Cold Call",
firstName: "Elon",
lastName: "Musk",
description: "A thinker",
prefix: "Sir",
title: "CEO",
language: "EN",
status: "New",
monetaryAmount: 75000,
currency: "USD",
fax: "+12129876543",
websites: [
{
id: "12345",
url: "http://example.com",
type: "primary",
},
{
id: "12345",
url: "http://example.com",
type: "primary",
},
],
addresses: [
{
id: "123",
type: "primary",
string: "25 Spring Street, Blackburn, VIC 3130",
name: "HQ US",
line1: "Main street",
line2: "apt #",
line3: "Suite #",
line4: "delivery instructions",
streetNumber: "25",
city: "San Francisco",
state: "CA",
postalCode: "94104",
country: "US",
latitude: "40.759211",
longitude: "-73.984638",
county: "Santa Clara",
contactName: "Elon Musk",
salutation: "Mr",
phoneNumber: "111-111-1111",
fax: "122-111-1111",
email: "elon@musk.com",
website: "https://elonmusk.com",
notes: "Address notes or delivery instructions.",
rowVersion: "1-12345",
},
],
socialLinks: [
{
id: "12345",
url: "https://www.twitter.com/apideck",
type: "twitter",
},
{
id: "12345",
url: "https://www.twitter.com/apideck",
type: "twitter",
},
{
id: "12345",
url: "https://www.twitter.com/apideck",
type: "twitter",
},
],
phoneNumbers: [
{
id: "12345",
countryCode: "1",
areaCode: "323",
number: "111-111-1111",
extension: "105",
type: "primary",
},
{
id: "12345",
countryCode: "1",
areaCode: "323",
number: "111-111-1111",
extension: "105",
type: "primary",
},
{
id: "12345",
countryCode: "1",
areaCode: "323",
number: "111-111-1111",
extension: "105",
type: "primary",
},
],
emails: [
{
id: "123",
email: "elon@musk.com",
type: "primary",
},
],
customFields: [
{
id: "2389328923893298",
name: "employee_level",
description: "Employee Level",
value: "Uses Salesforce and Marketo",
},
{
id: "2389328923893298",
name: "employee_level",
description: "Employee Level",
value: 10,
},
{
id: "2389328923893298",
name: "employee_level",
description: "Employee Level",
value: [
"<value>",
"<value>",
],
},
],
tags: [
"New",
],
passThrough: [
{
serviceId: "<id>",
extendPaths: [
{
path: "$.nested.property",
value: {
"TaxClassificationRef": {
"value": "EUC-99990201-V1-00020000",
},
},
},
{
path: "$.nested.property",
value: {
"TaxClassificationRef": {
"value": "EUC-99990201-V1-00020000",
},
},
},
],
},
{
serviceId: "<id>",
extendPaths: [
{
path: "$.nested.property",
value: {
"TaxClassificationRef": {
"value": "EUC-99990201-V1-00020000",
},
},
},
],
},
],
},
});
if (!res.ok) {
throw res.error;
}
const { value: result } = res;
// Handle the result
console.log(result);
}
run();| Parameter | Type | Required | Description |
|---|---|---|---|
request |
operations.CrmLeadsUpdateRequest | ✔️ | The request object to use for the request. |
options |
RequestOptions | ➖ | Used to set various options for making HTTP requests. |
options.fetchOptions |
RequestInit | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed. |
options.retries |
RetryConfig | ➖ | Enables retrying HTTP requests under certain failure conditions. |
Promise<operations.CrmLeadsUpdateResponse>
| Error Type | Status Code | Content Type |
|---|---|---|
| errors.BadRequestResponse | 400 | application/json |
| errors.UnauthorizedResponse | 401 | application/json |
| errors.PaymentRequiredResponse | 402 | application/json |
| errors.NotFoundResponse | 404 | application/json |
| errors.UnprocessableResponse | 422 | application/json |
| errors.APIError | 4XX, 5XX | */* |
Delete lead
import { Apideck } from "@apideck/unify";
const apideck = new Apideck({
apiKey: process.env["APIDECK_API_KEY"] ?? "",
consumerId: "test-consumer",
appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
});
async function run() {
const result = await apideck.crm.leads.delete({
id: "<id>",
serviceId: "salesforce",
});
// Handle the result
console.log(result);
}
run();The standalone function version of this method:
import { ApideckCore } from "@apideck/unify/core.js";
import { crmLeadsDelete } from "@apideck/unify/funcs/crmLeadsDelete.js";
// Use `ApideckCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const apideck = new ApideckCore({
apiKey: process.env["APIDECK_API_KEY"] ?? "",
consumerId: "test-consumer",
appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
});
async function run() {
const res = await crmLeadsDelete(apideck, {
id: "<id>",
serviceId: "salesforce",
});
if (!res.ok) {
throw res.error;
}
const { value: result } = res;
// Handle the result
console.log(result);
}
run();| Parameter | Type | Required | Description |
|---|---|---|---|
request |
operations.CrmLeadsDeleteRequest | ✔️ | The request object to use for the request. |
options |
RequestOptions | ➖ | Used to set various options for making HTTP requests. |
options.fetchOptions |
RequestInit | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed. |
options.retries |
RetryConfig | ➖ | Enables retrying HTTP requests under certain failure conditions. |
Promise<operations.CrmLeadsDeleteResponse>
| Error Type | Status Code | Content Type |
|---|---|---|
| errors.BadRequestResponse | 400 | application/json |
| errors.UnauthorizedResponse | 401 | application/json |
| errors.PaymentRequiredResponse | 402 | application/json |
| errors.NotFoundResponse | 404 | application/json |
| errors.UnprocessableResponse | 422 | application/json |
| errors.APIError | 4XX, 5XX | */* |