Imprezian360-CRM (Preview)

Imprezian360-CRM (Preview)

Imprezian360 CRM All-In-One

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
Flow Premium All Flow regions
PowerApps Premium All PowerApps regions

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Creating a connection

To connect your account, you will need the following information:

username
securestring
The username for this api
password
securestring
The password for this api

Actions

Add New Member

Operation ID:
Members_PostValue

Adds a marketing campaign member

Optional Parameters

Campaign ID
string
The ID of the campaign to link to
Key:
promoid
Record Type
string
L for Lead, C for Contact
Key:
recordtype
Contact ID
string
Contact ID or Lead ID tied to campaign
Key:
recordid

Create New Campaign

Operation ID:
Campaign_PostValue

Creates a new marketing campaign in the CRM

Required Parameters

Campaign Description
string
A description of the campaign
Key:
description
Expiration Date
date
Date the campaign expires
Key:
expires
Total Budget
float
The total budget for the campaign
Key:
budget

Optional Parameters

Start Date
date
The start date of the campaign
Key:
startdate
Promotion Category
string
The type or category of the campaign (such as Google Search)
Key:
promotype
Employee (Manager)
string
The employee who manages the campaign
Key:
manager

Create New ComLog

Operation ID:
ComLog_PostValue

New Communication Entry

Optional Parameters

Contact ID
string
The contact ID of the communication (blank for lead)
Key:
contactid
Lead ID
string
The Lead ID of the communication (zero for contact based)
Key:
leadid
Communication Type
string
E-Mail, Phone-call, etc
Key:
type
Subject
string
Subject of communication
Key:
subject
Content of the communication
string
body
Key:
body
Employee Name
string
CRM Employee name who performed action
Key:
employee
Start Time of Communication
string
starttime
Key:
starttime
End Time
string
endtime
Key:
endtime
Work Order Link
string
Work order number of communication
Key:
workorder
Project ID
string
Project linked to communication
Key:
project
Marketing campaign
string
The marketing campaign linked to the communication
Key:
campaign
Length of communication
number
length
Key:
length
Is Billed
boolean
Has the communication entry been billed by the CRM
Key:
billed
InBound
boolean
Is communication inbound (false = outbound)
Key:
inbound

Create New FollowUp

Operation ID:
FollowUp_PostValue

Creates a new followup

Optional Parameters

Contact ID
string
The contact ID linked to the followup (blank for lead)
Key:
contactid
Lead ID
string
The lead ID of the followup (0 for contact)
Key:
leadid
Follow Up Type
string
The type of the follow up (Call Back, GoToMeeting, etc)
Key:
type
Comments or Instructions
string
Comments or Instructions related to the followup
Key:
comments
Employee Assigned To
string
The employee name assigned to the followup
Key:
assignedto
Employee Set By
string
The employee name that set the followup
Key:
setby
Due Date
string
The due date of the followup
Key:
duedate
Is Urgent
boolean
Is this followup urgent
Key:
urgent
Reminder Minutes
number
Number of minutes before event for reminder (0 = none)
Key:
reminderminutes
Is Cleared
boolean
Is this followup Cleared
Key:
cleared

Create New Item

Operation ID:
ItemList_PostValue

All tags are required to be present, even if blank.

Optional Parameters

Part Number or SKU
string
The part number, Model Number or SKU of the item
Key:
modelno
Item Description
string
Sales description of item
Key:
descrip
Item Type
string
The type of the item (Inventory,NonInv,Misc,Discount,Service)
Key:
itemtype
Sales Price
number
The sales price of the item
Key:
price
Item Cost
number
Last and Average cost of item
Key:
cost
Vendor Name
string
The vendor name purchased from
Key:
vendor

Returns

New Code ID
string
New Code ID
Path:
id

Create New Lead

Operation ID:
Lead_PostValue

Creates a new sales lead

Optional Parameters

Saluation
string
Mr, Ms, etc
Key:
sal
First Name
string
First Name
Key:
firstname
Middle Name
string
Optional
Key:
middlename
Contact Title
string
Owner, VP, etc
Key:
title
Last Name
string
Last Name
Key:
lastname
Company Name
string
Optional
Key:
company
Address Line 1
string
Address Line 1
Key:
addr1
Address Line 2
string
Optional
Key:
addr2
Address City
string
Address City
Key:
city
Address State
string
State or Region
Key:
state
Address Zip or Postal
string
Zip Code or Postal Code
Key:
postal
Primary EMail
string
Email 1
Key:
email1
EMail 2
string
Email 2
Key:
email2
EMail 3
string
Email 3
Key:
email3
EMail 4
string
EMail 4
Key:
email4
Primary Phone Type
string
Home, Work, Cell, etc
Key:
phonetype1
Primary Phone
string
(xxx) xxx-xxxx
Key:
phone1
Phone Type 2
string
Work, Cell, Fax, etc
Key:
phonetype2
Alternate Phone
string
Phone 2
Key:
phone2
Phone Type 3
string
Work, Cell, Fax, etc
Key:
phonetype3
Alternate Phone
string
Phone 3
Key:
phone3
Phone Type 4
string
Work, Cell, Fax, Ettc
Key:
phonetype4
Alternate Phone
string
Phone 4
Key:
phone4
Quick Remark
string
A short remark
Key:
remark
Contact Notes
string
General Notes
Key:
notes
Campaign Name
string
The name (not the ID) of the marketing source
Key:
campaign
Lead Category
string
Category for the lead (such as Hot Lead, etc)
Key:
category
Contact Role
string
Decision maker, etc
Key:
role
Market Description
string
Description of market (Industrial, Bakeries, etc)
Key:
market
Territory
string
East, North, etc
Key:
territory
Sales Rep Name
string
The sales rep name (blank for unassigned)
Key:
salesrep
Last Contact Date
string
date of last contact
Key:
lastcontact

Create New Order

Operation ID:
SO_PostValue

Creates a new order

Optional Parameters

Order ID
string
External Order ID
Key:
orderid
Order Date
string
Date of Order
Key:
orderdate
Order Description
string
External Order Description
Key:
orderdescription
Account Number
string
Account number of customer (blank for new account)
Key:
account
Customer Name
string
Name of customer (becomes QB account name)
Key:
accountname
Sales Rep Name
string
Name of sales rep (blank for none)
Key:
salesrep
First Name
string
Contact First Name
Key:
firstname
Last Name
string
Contact Last Name
Key:
lastname
Billing EMail
string
Email address of billing contact
Key:
billemail
Billing Address 1
string
Address line 1
Key:
billaddr1
Billing Address 2
string
Address Line 2
Key:
billaddr2
Billing City
string
City or Region
Key:
billcity
Billing State
string
State or province
Key:
billstate
Billing Zip Code
string
zip or postal code
Key:
billzipcode
Billing Country
string
Name of Country (United States, Canada, etc)
Key:
billcountry
Billing Phone
string
phone number of billing contact
Key:
billphone
Billing Fax
string
Fax number of billing contact
Key:
billfax
Ship To Company
string
Company Name
Key:
shipcompany
Ship To Contact
string
Attention Contact
Key:
shipcontact
Shipping Line 1
string
Address line 1
Key:
shipaddr1
Shipping Line 2
string
Address Line 2
Key:
shipaddr2
Shipping City
string
Shipping City or Region
Key:
shipcity
Shipping State
string
State or Region
Key:
shipstate
Shipping Zip
string
Zip or Postal code
Key:
shipzipcode
Ship To Country
string
United States, Canada, etc
Key:
shipcountry
Ship To Phone
string
shipping phone number
Key:
shipphone
Ship To EMail
string
Shipping EMail address
Key:
shipemail
Order Status
string
Primary status of incoming order
Key:
orderstatus
Custom Status
string
In Fulfillment, Pending Review, etc
Key:
customstatus
Tax District
string
CA, FL, etc
Key:
taxdistrict
Tax Rate
float
Applied tax rate
Key:
taxrate
Campaign Name
string
Where order originated from (Google Search, etc)
Key:
campaign
Order Tax
string
Total tax of order
Key:
ordertax
Shipping Cost
string
Shipping cost billed on cart
Key:
shippingcost
Shipping Method
string
Preferred shipping method (UPS, etc)
Key:
shippingmethod
Coupone Amount
number
amount of coupon
Key:
couponamount
Coupon Code
string
Black Friday Sale, etc
Key:
couponcode
Payment Method
string
Visa, MC, etc
Key:
paymentmethod
Order Comments
string
comments related to order
Key:
comments
Item Qty
number
Line Item Qty
Key:
qty
Model Number
string
SKU of line item
Key:
modelno
Item Description
string
Description of line item
Key:
description
Order Line Item Comments
string
Item Related Comments
Key:
comments
Item Price
double
Line Item Price
Key:
price
Item Discount
string
Discount of line item (positive value)
Key:
discount

Create New Shipment

Operation ID:
Shipping_PostValue

Creates a shipment

Optional Parameters

Order ID
string
ID of order to ship
Key:
orderid
Shipping Date
string
Date of shipment
Key:
shipdate
Shipping Carrier
string
UPS, Fedex, etc
Key:
carrier
Shipping Method
string
Ground, Next Day Air, etc
Key:
method
Package Weight
number
Weight of shipment
Key:
weight
Packaging Type
string
Other, Box, Envelope, etc
Key:
packagetype
Reference 1
string
PO Number, etc
Key:
reference1
Reference 2
string
BOL, etc
Key:
reference2
Tracking Number
string
Carrier Tracking Number
Key:
trackingnumber
Tracking URL
string
URL to track shipment
Key:
trackingurl
Shipment Cost
number
Cost of shipment
Key:
shippingcost
Order In History
boolean
Is this order complete?
Key:
tohistory

Create New WorkOrder

Operation ID:
WorkOrder_PostValue

New Work-Order

Optional Parameters

Contact EMail
string
Email address of customer requesting work order
Key:
fromaddress
First Name
string
First Name
Key:
firstname
Last Name
string
Last Name
Key:
lastname
Company Name
string
Company Name
Key:
companyname
Billing Address 1
string
Address line 1
Key:
billaddr1
Billing Address 2
string
Address Line 2
Key:
billaddr2
Billing City
string
Bill city
Key:
billcity
Billing State
string
Billing state or region
Key:
billstate
Billing Zip
string
Bill zip or postal
Key:
billzipcode
Billing Country
string
United States, Canada, etc
Key:
billcountry
Billing Phone Number
string
billing phone number
Key:
billphone
Billing Fax
string
Bill fax number
Key:
billfax
Service Address 1
string
address to perform service
Key:
serviceaddr1
Service Address 2
string
address to perform service
Key:
serviceaddr2
Service City
string
address to perform service
Key:
servicecity
Service State
string
address to perform service
Key:
servicestate
Service Zip
string
zip or postal code
Key:
servicezipcode
Service Country
string
address to perform service
Key:
servicecountry
Service Phone Number
string
(xxx) xxx-xxxx
Key:
servicephone
Received Date
string
date time workorder was received
Key:
receiveddate
PO Number
string
Customer PO Number
Key:
ponumber
Status
string
Open,Pending Review, etc
Key:
status
Reason Code
string
Customer Request,Warranty,etc
Key:
reasoncode
Source
string
EMail, web, phone call etc
Key:
source
Assigned Technician
string
blank for unassigned
Key:
assignedto
Backup Technician
string
blank for unassigned
Key:
backup
Priority
string
Work Order Priority (0 Urgent = 4 Low)
Key:
priority
Due Date
string
Work order due by date
Key:
duedate
Subject
string
Brief summary of request
Key:
subject
WO Content
string
Descriptive text of Work Order
Key:
body

Create new CRM Contact

Operation ID:
Contact_PostValue

Creates a qualified prospect, customer or vendor

Optional Parameters

account
string
account
Key:
account
sal
string
sal
Key:
sal
firstname
string
firstname
Key:
firstname
middlename
string
middlename
Key:
middlename
title
string
title
Key:
title
lastname
string
lastname
Key:
lastname
company
string
company
Key:
company
addr1
string
addr1
Key:
addr1
addr2
string
addr2
Key:
addr2
city
string
city
Key:
city
state
string
state
Key:
state
postal
string
postal
Key:
postal
email1
string
email1
Key:
email1
email2
string
email2
Key:
email2
email3
string
email3
Key:
email3
email4
string
email4
Key:
email4
phonetype1
string
phonetype1
Key:
phonetype1
phone1
string
phone1
Key:
phone1
phonetype2
string
phonetype2
Key:
phonetype2
phone2
string
phone2
Key:
phone2
phonetype3
string
phonetype3
Key:
phonetype3
phone3
string
phone3
Key:
phone3
phonetype4
string
phonetype4
Key:
phonetype4
phone4
string
phone4
Key:
phone4
remark
string
remark
Key:
remark
notes
string
notes
Key:
notes
campaign
string
campaign
Key:
campaign
category
string
category
Key:
category
market
string
market
Key:
market
territory
string
territory
Key:
territory
salesrep
string
salesrep
Key:
salesrep
lastcontact
date-time
lastcontact
Key:
lastcontact

Get Active Leads

Operation ID:
Lead_GetValues

Returns a list of active sales leads

Optional Parameters

Campaign ID
string
The ID of the campaign to link to
Key:
promoid
Record Type
string
L for Lead, C for Contact
Key:
recordtype
Contact ID
string
Contact ID or Lead ID tied to campaign
Key:
recordid

Returns

array of string
Returns a list of active sales leads

Get Active Orders

Operation ID:
SO_GetValues

Returns a list of active orders

Optional Parameters

Campaign ID
string
The ID of the campaign to link to
Key:
promoid
Record Type
string
L for Lead, C for Contact
Key:
recordtype
Contact ID
string
Contact ID or Lead ID tied to campaign
Key:
recordid

Returns

array of string
Returns a list of active orders

Get Campaign List

Operation ID:
Campaign_GetValues

Returns a list of campaigns

Optional Parameters

Campaign ID
string
The ID of the campaign to link to
Key:
promoid
Record Type
string
L for Lead, C for Contact
Key:
recordtype
Contact ID
string
Contact ID or Lead ID tied to campaign
Key:
recordid

Returns

array of string
Returns a list of campaigns

Get ComLogs

Operation ID:
ComLog_GetValues

Returns a list of requested communication ID's

Optional Parameters

Campaign ID
string
The ID of the campaign to link to
Key:
promoid
Record Type
string
L for Lead, C for Contact
Key:
recordtype
Contact ID
string
Contact ID or Lead ID tied to campaign
Key:
recordid

Returns

array of string
Returns a list of requested communication ID's

Get Contact List

Operation ID:
Contact_GetValues

retrieves a list of contacts

Optional Parameters

Campaign ID
string
The ID of the campaign to link to
Key:
promoid
Record Type
string
L for Lead, C for Contact
Key:
recordtype
Contact ID
string
Contact ID or Lead ID tied to campaign
Key:
recordid

Returns

array of string
retrieves a list of contacts

Get FollowUp List

Operation ID:
FollowUp_GetValues

Retrieve list of followups

Optional Parameters

Campaign ID
string
The ID of the campaign to link to
Key:
promoid
Record Type
string
L for Lead, C for Contact
Key:
recordtype
Contact ID
string
Contact ID or Lead ID tied to campaign
Key:
recordid

Returns

array of string
Retrieve list of followups

Get Item List

Operation ID:
ItemList_GetValues

Returns a list of all items

Optional Parameters

Campaign ID
string
The ID of the campaign to link to
Key:
promoid
Record Type
string
L for Lead, C for Contact
Key:
recordtype
Contact ID
string
Contact ID or Lead ID tied to campaign
Key:
recordid

Returns

array of string
Returns a list of all items

Get Member List

Operation ID:
Members_GetValues

Marketing campaign members

Required Parameters

Supply L, C or B (required)
string
Type of campaign member (Lead, Contact or Both)
Key:
type

Returns

array of string
Marketing campaign members

Get Shipment List

Operation ID:
Shipping_GetValues

Returns a list of shipments

Optional Parameters

Campaign ID
string
The ID of the campaign to link to
Key:
promoid
Record Type
string
L for Lead, C for Contact
Key:
recordtype
Contact ID
string
Contact ID or Lead ID tied to campaign
Key:
recordid

Returns

array of string
Returns a list of shipments

Get WorkOrder List

Operation ID:
WorkOrder_GetValues

List of workorders

Optional Parameters

Campaign ID
string
The ID of the campaign to link to
Key:
promoid
Record Type
string
L for Lead, C for Contact
Key:
recordtype
Contact ID
string
Contact ID or Lead ID tied to campaign
Key:
recordid

Returns

array of string
List of workorders

Remove Campaign Member

Operation ID:
Members_PutValue

Removes a marketing campaign member

Required Parameters

Member ID
string
Member ID
Key:
id

Optional Parameters

Operation
string
only Remove supported at this time
Key:
operation
Record Type
string
L for Lead, C for contact
Key:
recordtype
Campaign ID
string
ID of campaign
Key:
promoid
Record ID
string
Numeric id of lead or alphanumeric id of contact
Key:
recordid

Retrieve CRM Contact Details

Operation ID:
Contact_GetValue

Retrieves details about the specified contact

Required Parameters

Contact ID
string
Contact ID
Key:
id

Retrieve Campaign Details

Operation ID:
Campaign_GetValue

Retrieves the details of a specific campaign request by id

Required Parameters

Campaign ID
string
Campaign ID
Key:
id

Returns

PromoID
string
PromoID
Path:
PromoID
Campaign Manager
string
Campaign Manager
Path:
Campaign Manager
IS INACTIVE
string
IS INACTIVE
Path:
IS INACTIVE
IN HISTORY
string
IN HISTORY
Path:
IN HISTORY
Used For Discounting
string
Used For Discounting
Path:
Used For Discounting
Used For Mail Broadcasting
string
Used For Mail Broadcasting
Path:
Used For Mail Broadcasting
budget
string
budget
Path:
budget
Promotion Type
string
Promotion Type
Path:
Promotion Type
description
string
description
Path:
description
Employee Name
string
Employee Name
Path:
Employee Name
Start Date
string
Start Date
Path:
Start Date
Expiration Date
string
Expiration Date
Path:
Expiration Date
Revenue
string
Revenue
Path:
Revenue

Retrieve ComLog Details

Operation ID:
ComLog_GetValue

Returns field details

Required Parameters

Communication ID
string
Communication ID
Key:
id

Returns

Direction
string
Direction
Path:
Direction
account
string
account
Path:
account
Account Name
string
Account Name
Path:
Account Name
Contact Name
string
Contact Name
Path:
Contact Name
Start Date
string
Start Date
Path:
Start Date
End Date
string
End Date
Path:
End Date
Employee Name
string
Employee Name
Path:
Employee Name
Type
string
Type
Path:
Type
Length
string
Length
Path:
Length
Subject
string
Subject
Path:
Subject
Content
string
Content
Path:
Content
Billed
string
Billed
Path:
Billed
Work Order
string
Work Order
Path:
Work Order
Sales Order
string
Sales Order
Path:
Sales Order
Sales Lead
string
Sales Lead
Path:
Sales Lead
Project ID
string
Project ID
Path:
Project ID
Recipient
string
Recipient
Path:
Recipient
cc
string
cc
Path:
cc
Bcc
string
Bcc
Path:
Bcc
CallNumber
string
CallNumber
Path:
CallNumber
RecordID
string
RecordID
Path:
RecordID
Company Name
string
Company Name
Path:
Company Name

Retrieve Item Details

Operation ID:
ItemList_GetValue

Details about a specific item

Required Parameters

Item Id
string
Item id
Key:
id

Returns

Code
string
Code
Path:
Code
Model Number
string
Model Number
Path:
Model Number
Description
string
Description
Path:
Description
Sales Description
string
Sales Description
Path:
Sales Description
Purchase Description
string
Purchase Description
Path:
Purchase Description
Item Type
string
Item Type
Path:
Item Type
Base Price
string
Base Price
Path:
Base Price
Avg Cost
string
Avg Cost
Path:
Avg Cost
Primary Category
string
Primary Category
Path:
Primary Category
Category2
string
Category2
Path:
Category2
Category3
string
Category3
Path:
Category3
Category4
string
Category4
Path:
Category4
Category5
string
Category5
Path:
Category5
Base UOM
string
Base UOM
Path:
Base UOM
Sell UOM
string
Sell UOM
Path:
Sell UOM
Buy UOM
string
Buy UOM
Path:
Buy UOM
Base Warehouse
string
Base Warehouse
Path:
Base Warehouse
On Hand
string
On Hand
Path:
On Hand
On SO
string
On SO
Path:
On SO
Bad
string
Bad
Path:
Bad
On WO
string
On WO
Path:
On WO
On PO
string
On PO
Path:
On PO
Available
string
Available
Path:
Available
Taxable
string
Taxable
Path:
Taxable
Tax 2
string
Tax 2
Path:
Tax 2
Pays Commission
string
Pays Commission
Path:
Pays Commission
Fixed Price
string
Fixed Price
Path:
Fixed Price
Discounting Prohibited
string
Discounting Prohibited
Path:
Discounting Prohibited
Call For Price
string
Call For Price
Path:
Call For Price
Call For Cost
string
Call For Cost
Path:
Call For Cost
Gratis Item
string
Gratis Item
Path:
Gratis Item
Hidden on Printouts
string
Hidden on Printouts
Path:
Hidden on Printouts
Exclude From Margin
string
Exclude From Margin
Path:
Exclude From Margin
Track Serial Numbers
string
Track Serial Numbers
Path:
Track Serial Numbers
Serialization Mode
string
Serialization Mode
Path:
Serialization Mode
Serial Number Required
string
Serial Number Required
Path:
Serial Number Required
Prohibit Duplicate Serial Numbers
string
Prohibit Duplicate Serial Numbers
Path:
Prohibit Duplicate Serial Numbers
Expiration Date Applies
string
Expiration Date Applies
Path:
Expiration Date Applies
Shipping Charges Apply
string
Shipping Charges Apply
Path:
Shipping Charges Apply
Item must ship seperately
string
Item must ship seperately
Path:
Item must ship seperately
Group Ship Items
string
Group Ship Items
Path:
Group Ship Items
Drop-Ship From Vendor
string
Drop-Ship From Vendor
Path:
Drop-Ship From Vendor
Height
string
Height
Path:
Height
Width
string
Width
Path:
Width
Depth
string
Depth
Path:
Depth
Weight
string
Weight
Path:
Weight
Box Limit
string
Box Limit
Path:
Box Limit
Lead Time
string
Lead Time
Path:
Lead Time
Last Cost
string
Last Cost
Path:
Last Cost
Reorder Point
string
Reorder Point
Path:
Reorder Point
Item Message
string
Item Message
Path:
Item Message
ON SALE
string
ON SALE
Path:
ON SALE
IS ASSEMBLY
string
IS ASSEMBLY
Path:
IS ASSEMBLY
Manufacturer Part Number
string
Manufacturer Part Number
Path:
Manufacturer Part Number
OEM
string
OEM
Path:
OEM
BIN Location
string
BIN Location
Path:
BIN Location
Primary Vendor
string
Primary Vendor
Path:
Primary Vendor
Vendor 1 Part #
string
Vendor 1 Part #
Path:
Vendor 1 Part #
Vendor 1 Descrip
string
Vendor 1 Descrip
Path:
Vendor 1 Descrip
Vendor 1 Cost
string
Vendor 1 Cost
Path:
Vendor 1 Cost
Vendor 1 Date Cost Verified
string
Vendor 1 Date Cost Verified
Path:
Vendor 1 Date Cost Verified
Vendor 2
string
Vendor 2
Path:
Vendor 2
Vendor 2 Part #
string
Vendor 2 Part #
Path:
Vendor 2 Part #
Vendor 2 Descrip
string
Vendor 2 Descrip
Path:
Vendor 2 Descrip
Vendor 2 Cost
string
Vendor 2 Cost
Path:
Vendor 2 Cost
Vendor 2 Date Cost Verified
string
Vendor 2 Date Cost Verified
Path:
Vendor 2 Date Cost Verified
Vendor 3
string
Vendor 3
Path:
Vendor 3
Vendor 3 Part #
string
Vendor 3 Part #
Path:
Vendor 3 Part #
Vendor 3 Descrip
string
Vendor 3 Descrip
Path:
Vendor 3 Descrip
Vendor 3 Cost
string
Vendor 3 Cost
Path:
Vendor 3 Cost
Vendor 3 Date Cost Verified
string
Vendor 3 Date Cost Verified
Path:
Vendor 3 Date Cost Verified
Vendor 4
string
Vendor 4
Path:
Vendor 4
Vendor 4 Part #
string
Vendor 4 Part #
Path:
Vendor 4 Part #
Vendor 4 Descrip
string
Vendor 4 Descrip
Path:
Vendor 4 Descrip
Vendor 4 Cost
string
Vendor 4 Cost
Path:
Vendor 4 Cost
Vendor 4 Date Cost Verified
string
Vendor 4 Date Cost Verified
Path:
Vendor 4 Date Cost Verified
Vendor 5
string
Vendor 5
Path:
Vendor 5
Vendor 5 Part #
string
Vendor 5 Part #
Path:
Vendor 5 Part #
Vendor 5 Descrip
string
Vendor 5 Descrip
Path:
Vendor 5 Descrip
Vendor 5 Cost
string
Vendor 5 Cost
Path:
Vendor 5 Cost
Vendor 5 Date Cost Verified
string
Vendor 5 Date Cost Verified
Path:
Vendor 5 Date Cost Verified
Price Level Mode
string
Price Level Mode
Path:
Price Level Mode
Price Level 2
string
Price Level 2
Path:
Price Level 2
Price Level 3
string
Price Level 3
Path:
Price Level 3
Price Level 4
string
Price Level 4
Path:
Price Level 4
Price Level 5
string
Price Level 5
Path:
Price Level 5
Price Level 6
string
Price Level 6
Path:
Price Level 6
Price Level 7
string
Price Level 7
Path:
Price Level 7
Price Level 8
string
Price Level 8
Path:
Price Level 8
Price Level 9
string
Price Level 9
Path:
Price Level 9
Price Level 10
string
Price Level 10
Path:
Price Level 10
Price Level 11
string
Price Level 11
Path:
Price Level 11
Price Level 12
string
Price Level 12
Path:
Price Level 12
Price Level 13
string
Price Level 13
Path:
Price Level 13
Price Level 14
string
Price Level 14
Path:
Price Level 14
Price Level 15
string
Price Level 15
Path:
Price Level 15
Price Level 16
string
Price Level 16
Path:
Price Level 16
Price Level 17
string
Price Level 17
Path:
Price Level 17
Price Level 18
string
Price Level 18
Path:
Price Level 18
Price Level 19
string
Price Level 19
Path:
Price Level 19
Price Level 20
string
Price Level 20
Path:
Price Level 20
Quantity Level 1
string
Quantity Level 1
Path:
Quantity Level 1
Quantity Price 1
string
Quantity Price 1
Path:
Quantity Price 1
Quantity Price Level 1
string
Quantity Price Level 1
Path:
Quantity Price Level 1
Quantity Level 2
string
Quantity Level 2
Path:
Quantity Level 2
Quantity Price 2
string
Quantity Price 2
Path:
Quantity Price 2
Quantity Price Level 2
string
Quantity Price Level 2
Path:
Quantity Price Level 2
Quantity Level 3
string
Quantity Level 3
Path:
Quantity Level 3
Quantity Price 3
string
Quantity Price 3
Path:
Quantity Price 3
Quantity Price Level 3
string
Quantity Price Level 3
Path:
Quantity Price Level 3
Quantity Level 4
string
Quantity Level 4
Path:
Quantity Level 4
Quantity Price 4
string
Quantity Price 4
Path:
Quantity Price 4
Quantity Price Level 4
string
Quantity Price Level 4
Path:
Quantity Price Level 4
Quantity Level 5
string
Quantity Level 5
Path:
Quantity Level 5
Quantity Price 5
string
Quantity Price 5
Path:
Quantity Price 5
Quantity Price Level 5
string
Quantity Price Level 5
Path:
Quantity Price Level 5
Quantity Level 6
string
Quantity Level 6
Path:
Quantity Level 6
Quantity Price 6
string
Quantity Price 6
Path:
Quantity Price 6
Quantity Price Level 6
string
Quantity Price Level 6
Path:
Quantity Price Level 6
Quantity Level 7
string
Quantity Level 7
Path:
Quantity Level 7
Quantity Price 7
string
Quantity Price 7
Path:
Quantity Price 7
Quantity Price Level 7
string
Quantity Price Level 7
Path:
Quantity Price Level 7
Quantity Level 8
string
Quantity Level 8
Path:
Quantity Level 8
Quantity Price 8
string
Quantity Price 8
Path:
Quantity Price 8
Quantity Price Level 8
string
Quantity Price Level 8
Path:
Quantity Price Level 8
Quantity Level 9
string
Quantity Level 9
Path:
Quantity Level 9
Quantity Price 9
string
Quantity Price 9
Path:
Quantity Price 9
Quantity Price Level 9
string
Quantity Price Level 9
Path:
Quantity Price Level 9
Quantity Level 10
string
Quantity Level 10
Path:
Quantity Level 10
Quantity Price 10
string
Quantity Price 10
Path:
Quantity Price 10
Quantity Price Level 10
string
Quantity Price Level 10
Path:
Quantity Price Level 10

Retrieve Lead Details

Operation ID:
Lead_GetValue

retrieves the lead details

Required Parameters

Lead ID
string
Lead ID
Key:
id

Returns

type
string
type
Path:
type
leadid
string
leadid
Path:
leadid
Category
string
Category
Path:
Category
recordid
string
recordid
Path:
recordid
Company Name
string
Company Name
Path:
Company Name
Salutation
string
Salutation
Path:
Salutation
First Name
string
First Name
Path:
First Name
Last Name
string
Last Name
Path:
Last Name
Address Line 1
string
Address Line 1
Path:
Address Line 1
Address Line 2
string
Address Line 2
Path:
Address Line 2
City
string
City
Path:
City
State
string
State
Path:
State
Postal Code
string
Postal Code
Path:
Postal Code
Country
string
Country
Path:
Country
Time-Zone
string
Time-Zone
Path:
Time-Zone
Latitude
string
Latitude
Path:
Latitude
Longitude
string
Longitude
Path:
Longitude
Title
string
Title
Path:
Title
Contact Type
string
Contact Type
Path:
Contact Type
Sales Rep
string
Sales Rep
Path:
Sales Rep
Phone Extension
string
Phone Extension
Path:
Phone Extension
Last Contact Date
string
Last Contact Date
Path:
Last Contact Date
Contact Notes
string
Contact Notes
Path:
Contact Notes
Quick Remark
string
Quick Remark
Path:
Quick Remark
Created Date
string
Created Date
Path:
Created Date
Market
string
Market
Path:
Market
Sales Territory
string
Sales Territory
Path:
Sales Territory
Primary Email
string
Primary Email
Path:
Primary Email
EMail 2
string
EMail 2
Path:
EMail 2
Email 3
string
Email 3
Path:
Email 3
Email 4
string
Email 4
Path:
Email 4
OPTOUT
string
OPTOUT
Path:
OPTOUT
Phone1
string
Phone1
Path:
Phone1
Phone2
string
Phone2
Path:
Phone2
Phone3
string
Phone3
Path:
Phone3
Phone4
string
Phone4
Path:
Phone4
Promotion Memberships
string
Promotion Memberships
Path:
Promotion Memberships
Source
string
Source
Path:
Source
Source Notes
string
Source Notes
Path:
Source Notes
Website
string
Website
Path:
Website
Twitter
string
Twitter
Path:
Twitter
Facebook
string
Facebook
Path:
Facebook
LinkedIn
string
LinkedIn
Path:
LinkedIn
Product Interest
string
Product Interest
Path:
Product Interest
Assigned To Rep
string
Assigned To Rep
Path:
Assigned To Rep

Retrieve Member Details

Operation ID:
Members_GetValue

retrieve details about a member

Required Parameters

Id of member
string
Id of member
Key:
id

Returns

Record ID
string
Record ID (numeric for lead, alpha for contact)
Path:
recordid
Contact Title
string
Mr, Ms, etc
Path:
title
First Name
string
First name
Path:
fname
Last Name
string
Last Name
Path:
lname
Address Line 1
string
Address Line 1
Path:
addr1
Address Line 2
string
Address Line 2
Path:
addr2
Address City
string
Address City
Path:
city
Address State
string
State or Province
Path:
state
Address Zip
string
Zip or Postal Code
Path:
zipcode
Primary EMail
string
Email
Path:
email
Alternate Email 2
string
Email 2
Path:
email2
Alternate Email 3
string
Email 3
Path:
email3
Alternate Email 4
string
Email 4
Path:
email4
Primary Phone
string
Phone 1
Path:
phone1
Alternate Phone 2
string
Phone 2
Path:
phone2
Alternate Phone 3
string
Phone 3
Path:
phone3
Alternate Phone 4
string
Phone 4
Path:
phone4

Retrieve Order Details

Operation ID:
SO_GetValue

Retrieve details of an order

Required Parameters

SalesOrder ID
string
id of salesorder
Key:
id

Returns

Order ID
string
Order ID
Path:
Order ID
PROCESSING PHASE
string
PROCESSING PHASE
Path:
PROCESSING PHASE
Account
string
Account
Path:
Account
Account Name
string
Account Name
Path:
Account Name
Sales Rep
string
Sales Rep
Path:
Sales Rep
Custom Status
string
Custom Status
Path:
Custom Status
Description
string
Description
Path:
Description
Quotation Date
string
Quotation Date
Path:
Quotation Date
Close Date
string
Close Date
Path:
Close Date
Ship Date
string
Ship Date
Path:
Ship Date
Expiration Date
string
Expiration Date
Path:
Expiration Date
Terms
string
Terms
Path:
Terms
Marketing Campaign
string
Marketing Campaign
Path:
Marketing Campaign
Shipping Warehouse
string
Shipping Warehouse
Path:
Shipping Warehouse
FOB
string
FOB
Path:
FOB
Deposit Required
string
Deposit Required
Path:
Deposit Required
Total Weight
string
Total Weight
Path:
Total Weight
Quote Amount
string
Quote Amount
Path:
Quote Amount
Partial Shipments OK
string
Partial Shipments OK
Path:
Partial Shipments OK
Invoice Shipping
string
Invoice Shipping
Path:
Invoice Shipping
IN HISTORY
string
IN HISTORY
Path:
IN HISTORY
IS INACTIVE
string
IS INACTIVE
Path:
IS INACTIVE
In-Pipeline
string
In-Pipeline
Path:
In-Pipeline
Tax 1
string
Tax 1
Path:
Tax 1
Tax 2
string
Tax 2
Path:
Tax 2
Is Template
string
Is Template
Path:
Is Template
Template Name
string
Template Name
Path:
Template Name
Customer PO
string
Customer PO
Path:
Customer PO
Ship To Company
string
Ship To Company
Path:
Ship To Company
Ship To Contact
string
Ship To Contact
Path:
Ship To Contact
Ship To Addr 1
string
Ship To Addr 1
Path:
Ship To Addr 1
Ship To Addr 2
string
Ship To Addr 2
Path:
Ship To Addr 2
Ship To State
string
Ship To State
Path:
Ship To State
Ship To Postal Code
string
Ship To Postal Code
Path:
Ship To Postal Code
Ship To Country
string
Ship To Country
Path:
Ship To Country
Ship To Phone
string
Ship To Phone
Path:
Ship To Phone
Ship To EMail
string
Ship To EMail
Path:
Ship To EMail
Residential
string
Residential
Path:
Residential
Formatted Ship To
string
Formatted Ship To
Path:
Formatted Ship To
Paid Amount
string
Paid Amount
Path:
Paid Amount
Balance Due
string
Balance Due
Path:
Balance Due
QB Invoice Number
string
QB Invoice Number
Path:
QB Invoice Number
Confirmed Order
string
Confirmed Order
Path:
Confirmed Order
Commission
string
Commission
Path:
Commission
TotalCost
string
TotalCost
Path:
TotalCost
Margin
string
Margin
Path:
Margin
Project ID
string
Project ID
Path:
Project ID
Next Appointment
string
Next Appointment
Path:
Next Appointment
Appointment With
string
Appointment With
Path:
Appointment With
linedata:
array of object
linedata:
Path:
linedata:
itemid
string
itemid
Path:
linedata:.itemid
orderqty
string
orderqty
Path:
linedata:.orderqty
uom
string
uom
Path:
linedata:.uom
modelno
string
modelno
Path:
linedata:.modelno
descrip
string
descrip
Path:
linedata:.descrip
comments
string
comments
Path:
linedata:.comments
shippedqty
string
shippedqty
Path:
linedata:.shippedqty
price
string
price
Path:
linedata:.price
subttl
string
subttl
Path:
linedata:.subttl
total
string
total
Path:
linedata:.total

Retrieve Shipment Details

Operation ID:
Shipping_GetValue

get shipment details

Required Parameters

Order ID
string
desired Order ID
Key:
id

Returns

Customer
string
Customer
Path:
Customer
Order ID
string
Order ID
Path:
Order ID
Model Number
string
Model Number
Path:
Model Number
Descrip
string
Descrip
Path:
Descrip
Shipped Qty
string
Shipped Qty
Path:
Shipped Qty
BoxID
string
BoxID
Path:
BoxID
Tracking
string
Tracking
Path:
Tracking
Ship Date
string
Ship Date
Path:
Ship Date
Shipped By
string
Shipped By
Path:
Shipped By
SerialData
string
SerialData
Path:
SerialData
Ship_Company
string
Ship_Company
Path:
Ship_Company
Ship_Contact
string
Ship_Contact
Path:
Ship_Contact
Ship_Addr1
string
Ship_Addr1
Path:
Ship_Addr1
Ship_Addr2
string
Ship_Addr2
Path:
Ship_Addr2
Ship_City
string
Ship_City
Path:
Ship_City
Ship_State
string
Ship_State
Path:
Ship_State
Ship_ZipCode
string
Ship_ZipCode
Path:
Ship_ZipCode
Ship_Phone
string
Ship_Phone
Path:
Ship_Phone
Carrier
string
Carrier
Path:
Carrier
ShipmentID
string
ShipmentID
Path:
ShipmentID
ItemID
string
ItemID
Path:
ItemID

Retrieve WorkOrder Details

Operation ID:
WorkOrder_GetValue

Returns details of a WO

Required Parameters

Workorder ID
string
id of workorder
Key:
id

Returns

Work Order Number
string
Work Order Number
Path:
Work Order Number
IN HISTORY
string
IN HISTORY
Path:
IN HISTORY
INACTIVE
string
INACTIVE
Path:
INACTIVE
Priority
string
Priority
Path:
Priority
account
string
account
Path:
account
Customer Name
string
Customer Name
Path:
Customer Name
summary
string
summary
Path:
summary
Content
string
Content
Path:
Content
Assigned To
string
Assigned To
Path:
Assigned To
Backup Assignment
string
Backup Assignment
Path:
Backup Assignment
Received Date
string
Received Date
Path:
Received Date
Due By
string
Due By
Path:
Due By
Opened-By
string
Opened-By
Path:
Opened-By
CONTRACT ID
string
CONTRACT ID
Path:
CONTRACT ID
Source
string
Source
Path:
Source
Custom Status
string
Custom Status
Path:
Custom Status
Reason Code
string
Reason Code
Path:
Reason Code
Customer Reference Number
string
Customer Reference Number
Path:
Customer Reference Number
Service-To Company
string
Service-To Company
Path:
Service-To Company
Service-To Contact
string
Service-To Contact
Path:
Service-To Contact
Service-To Address Line 1
string
Service-To Address Line 1
Path:
Service-To Address Line 1
Service-To Address Line 2
string
Service-To Address Line 2
Path:
Service-To Address Line 2
Service-To City
string
Service-To City
Path:
Service-To City
Service-To State
string
Service-To State
Path:
Service-To State
Service-To Postal Code
string
Service-To Postal Code
Path:
Service-To Postal Code
Service-To Phone
string
Service-To Phone
Path:
Service-To Phone
Service-To Country
string
Service-To Country
Path:
Service-To Country
Service-To County
string
Service-To County
Path:
Service-To County
Latitude
string
Latitude
Path:
Latitude
Longitude
string
Longitude
Path:
Longitude
Time-Zone
string
Time-Zone
Path:
Time-Zone
Formatted Service Address
string
Formatted Service Address
Path:
Formatted Service Address
Created Date
string
Created Date
Path:
Created Date
Customer Email
string
Customer Email
Path:
Customer Email
Customer PO
string
Customer PO
Path:
Customer PO
Service Appointment
string
Service Appointment
Path:
Service Appointment
Project ID
string
Project ID
Path:
Project ID
Total Charge
string
Total Charge
Path:
Total Charge
Time Spent
string
Time Spent
Path:
Time Spent

Retrieve followup Details

Operation ID:
FollowUp_GetValue

Followup details

Required Parameters

Follow Up ID
string
Follow Up ID
Key:
id

Returns

account
string
account
Path:
account
RecallID
string
RecallID
Path:
RecallID
Employee Name
string
Employee Name
Path:
Employee Name
SET FOR
string
SET FOR
Path:
SET FOR
SET BY
string
SET BY
Path:
SET BY
SET ON
string
SET ON
Path:
SET ON
IS CLEARED
string
IS CLEARED
Path:
IS CLEARED
Cleared By
string
Cleared By
Path:
Cleared By
Cleared On
string
Cleared On
Path:
Cleared On
ACCOUNT TYPE
string
ACCOUNT TYPE
Path:
ACCOUNT TYPE
Priority
string
Priority
Path:
Priority
TYPE
string
TYPE
Path:
TYPE
Details
string
Details
Path:
Details
Account Name
string
Account Name
Path:
Account Name
First Name
string
First Name
Path:
First Name
Last Name
string
Last Name
Path:
Last Name
Company Name
string
Company Name
Path:
Company Name
FollowUp Date
string
FollowUp Date
Path:
FollowUp Date
Reminder Time
string
Reminder Time
Path:
Reminder Time
WORK ORDER
string
WORK ORDER
Path:
WORK ORDER
Sales Lead
string
Sales Lead
Path:
Sales Lead
Project ID
string
Project ID
Path:
Project ID

Update CRM Contact Data

Operation ID:
Contact_PutValue

Update the specified CRM contact

Required Parameters

Contact ID
string
Contact ID
Key:
id

Optional Parameters

sal
string
sal
Key:
sal
firstname
string
firstname
Key:
firstname
middlename
string
middlename
Key:
middlename
title
string
title
Key:
title
lastname
string
lastname
Key:
lastname
company
string
company
Key:
company
addr1
string
addr1
Key:
addr1
addr2
string
addr2
Key:
addr2
city
string
city
Key:
city
state
string
state
Key:
state
postal
string
postal
Key:
postal
email1
string
email1
Key:
email1
email2
string
email2
Key:
email2
email3
string
email3
Key:
email3
email4
string
email4
Key:
email4
phonetype1
string
phonetype1
Key:
phonetype1
phone1
string
phone1
Key:
phone1
phonetype2
string
phonetype2
Key:
phonetype2
phone2
string
phone2
Key:
phone2
phonetype3
string
phonetype3
Key:
phonetype3
phone3
string
phone3
Key:
phone3
phonetype4
string
phonetype4
Key:
phonetype4
phone4
string
phone4
Key:
phone4
remark
string
remark
Key:
remark
notes
string
notes
Key:
notes
campaign
string
campaign
Key:
campaign
category
string
category
Key:
category
market
string
market
Key:
market
territory
string
territory
Key:
territory
salesrep
string
salesrep
Key:
salesrep
lastcontact
date-time
lastcontact
Key:
lastcontact

Update Campaign Data

Operation ID:
Campaign_PutValue

Updates a marketing campaign in the CRM

Required Parameters

Campaign ID
string
Campaign ID
Key:
id

Optional Parameters

Description
string
Updated description for the campaign
Key:
description
Start Date
string
What is the campaign start date
Key:
startdate
Updated Expiration
string
Updated expiration for the campaign
Key:
expires
Updated Budget
float
Updated budget for the campaign
Key:
budget
Campaign Manager
string
Which employee manages the campaign
Key:
manager
In History
boolean
Is the campaign in history
Key:
history

Update Comlog Data

Operation ID:
ComLog_PutValue

Updates a communication entry

Required Parameters

Communication ID
string
Communication ID
Key:
id

Optional Parameters

Communication Type
string
The type of the event
Key:
type
Subject
string
The subject of the event
Key:
subject
Content Body
string
The message content
Key:
body
Employee Name
string
The employee name that performed the action
Key:
employee
Start Date/Time
string
The event start date/time
Key:
starttime
End Time
string
The end time of the communication
Key:
endtime
Workorder ID
string
The work order number linked to the event
Key:
workorder
Project ID
string
The project ID of the communication
Key:
project
Campaign Link
string
The ID of the linked campaign
Key:
campaign
Event Length
number
How long the event took place
Key:
length
Is Billed
boolean
Has entry been invoiced in the CRM
Key:
billed
Inbound
boolean
Was the communication inbound
Key:
inbound

Update Item Data

Operation ID:
ItemList_PutValue

Updates an existing item

Required Parameters

Item ID
string
Item ID
Key:
id

Optional Parameters

Updated Description
string
The updated description for the item
Key:
descrip
Updated Price
number
The updated price for the item
Key:
price
Updated Cost
number
The updated average and last cost of the item
Key:
cost
Updated Vendor
string
The updated vendor for the item
Key:
vendor

Update Lead Data

Operation ID:
Lead_PutValue

Update an existing sales lead

Required Parameters

Lead ID
string
Lead ID
Key:
id

Optional Parameters

Salutation
string
Mr, Ms, Etc
Key:
sal
First Name
string
First Name
Key:
firstname
Middle Name
string
optional
Key:
middlename
Contact Title
string
VP, Owner, Janitor, etcf
Key:
title
Last Name
string
Required
Key:
lastname
Company Name
string
Optional
Key:
company
Address Line 1
string
Address Line 1
Key:
addr1
Address Line 2
string
Address Line 2
Key:
addr2
Address City
string
Address City
Key:
city
Address State
string
State or Region
Key:
state
Address Zip or Postal
string
Zip or postal code
Key:
postal
Primary EMail
string
Email 1
Key:
email1
EMail 2
string
Alternate Email
Key:
email2
EMail 3
string
Alternate EMail
Key:
email3
EMail 4
string
Alternate EMail
Key:
email4
Phone Type 1
string
Cell, Fax, etc
Key:
phonetype1
Primary Phone
string
(xxx) xxx-xxxx
Key:
phone1
Phone Type 2
string
Cell, Fax, etc
Key:
phonetype2
Phone 2
string
alternate phone
Key:
phone2
Phone Type 3
string
Cell, Fax, etc
Key:
phonetype3
Phone 3
string
alternate phone
Key:
phone3
Phone Type 4
string
Cell, fax, etc
Key:
phonetype4
Phone 4
string
alternate phone
Key:
phone4
Quick Remark
string
A short remark
Key:
remark
Contact Notes
string
General notes
Key:
notes
Marketing Campaign
string
Description (not ID) of the marketing campaign
Key:
campaign
Category
string
Hot Lead, etc
Key:
category
Contact Role
string
Decision Maker, etc
Key:
role
Market Name
string
Description of market (Bakeries, Chemical Factory, etc)
Key:
market
Territory Name
string
North, South, etc
Key:
territory
Sales Rep Name
string
Blank for unassigned
Key:
salesrep
Last Contact Date
string
date of last communication
Key:
lastcontact

Update Order Data

Operation ID:
SO_PutValue

Updates an existing order

Required Parameters

Order ID
string
Order ID
Key:
id

Optional Parameters

Additional order comments
string
appends order comments
Key:
comments
Update Custom Status
string
Pending Review, Confirmed, etc
Key:
customstatus
Official Order Status
string
quote,confirmed,shipping,history
Key:
orderstatus

Update Shipment Data

Operation ID:
Shipping_PutValue

Updates an existing shipment

Required Parameters

Shipment ID
string
Shipment ID
Key:
id

Optional Parameters

Shipment Date
string
date of shipment
Key:
shipdate
Shipment Carrier
string
UPS, Fedex, etc
Key:
carrier
Shipping Method
string
Ground, Next Day Air, etc
Key:
method
Shipment Weight
number
weight of shipment
Key:
weight
Package Type
string
Box, Envelope, etc
Key:
packagetype
Reference 1
string
PO Number,etc
Key:
reference1
Reference 2
string
BOL number, etc
Key:
reference2
Tracking Number
string
Carrier Tracking Number
Key:
trackingnumber
Tracking URL
string
Carrier Tracking URL
Key:
trackingurl
Shipping Cost
number
cost of shipment
Key:
shippingcost

Update WorkOrder Data

Operation ID:
WorkOrder_PutValue

Updates an existing WO

Required Parameters

WorkOrder ID
string
Workorder ID
Key:
id

Optional Parameters

PO Number
string
Customer PO Number
Key:
ponumber
Status
string
Custom status (Work In Progress,etc)
Key:
status
Reason
string
Reason for request
Key:
reasoncode
Source
string
Email,Phone,Web, etc
Key:
source
Assigned Technician
string
The employee name the WO is assigned to
Key:
assignedto
Assigned Backup
string
The employee name of the backup technician
Key:
backup
Priority
string
0(Critical) to 4-(Low)
Key:
priority
Due Date
string
due by date
Key:
duedate
Subject
string
A brief summary of the request
Key:
subject
WO Content
string
The body of the request
Key:
body
In History
boolean
places workorder in history
Key:
history

Update followup Data

Operation ID:
FollowUp_PutValue

Updates a followup

Required Parameters

Follow Up ID
string
Follow Up ID
Key:
id

Optional Parameters

Followup Type
string
The type of the followup (call back, gotomeeting, etc)
Key:
type
Note or Comments
string
Comments or Instructions related to followup
Key:
comments
Employee Assigned To
string
Employee name assigned to followup
Key:
assignedto
Employee Set By
string
Name of employee who set the followup
Key:
setby
Due Date
string
Due date of followup
Key:
duedate
Is Urgent
string
Is this followup Urgent
Key:
urgent
Reminder Minutes
number
Reminder minutes of followup (0=none)
Key:
reminderminutes
Is Cleared
boolean
Is this followup cleared
Key:
cleared

Triggers

New Lead Campaign Members

Operation ID:
New-Members-Leads

triggers when a lead has been added to a campaign

Required Parameters

Specify the campaign ID
integer
Campaign ID
Key:
PromotionID

Returns

Lead ID
string
The returned lead id from the request
Path:
lead id

New Marketing Campaign Created

Operation ID:
New-Marketing-Campaign

triggers when a new marketing campaign is created

Required Parameters

Specify the campaign ID
integer
Campaign ID
Key:
PromotionID

Returns

Promotion ID
string
the Id of the returned promotion
Path:
promoid

New Proposal Created

Operation ID:
New-Proposal-Created

triggers when a new proposal is created

Required Parameters

Specify the campaign ID
integer
Campaign ID
Key:
PromotionID

Returns

Quote ID
string
The quote Id of the request
Path:
Quote ID

New Sales Lead Created

Operation ID:
New-Sales-Lead

triggers when a new sales lead is created

Required Parameters

Specify the campaign ID
integer
Campaign ID
Key:
PromotionID

Returns

Lead ID
string
The lead id returned from the request
Path:
lead id

New Sales Order Created

Operation ID:
New-Sales-Order

triggers when a new sales order is created

Required Parameters

Specify the campaign ID
integer
Campaign ID
Key:
PromotionID

Returns

Order ID
string
Order ID
Path:
Order ID

Order In History

Operation ID:
Order-In-History

triggers when an order is complete and in history

Required Parameters

Specify the campaign ID
integer
Campaign ID
Key:
PromotionID

Returns

Order ID
string
the order id of the request
Path:
Order ID

Order In Processing

Operation ID:
Order-In-Processing

triggers when an order enters the processing phase

Required Parameters

Specify the campaign ID
integer
Campaign ID
Key:
PromotionID

Returns

Order ID
string
the order id of the request
Path:
Order ID

Order Is Shipping

Operation ID:
Order-Is-Shipping

triggers when an order enters the shipping phase

Required Parameters

Specify the campaign ID
integer
Campaign ID
Key:
PromotionID

Returns

Order ID
string
the order id of the request
Path:
Order ID

Order Status Has Changed

Operation ID:
Order-Status-Changed

triggers when the custom status of a quote or order changes

Required Parameters

Enter the desired SO Status
string
Status Text for Search
Key:
Status

Returns

Order ID
string
the order id of the request
Path:
Order ID

Proposal Needs Approval

Operation ID:
Proposal-Needs-Approval

triggers when a proposal enters the approval phase

Required Parameters

Specify the campaign ID
integer
Campaign ID
Key:
PromotionID

Returns

Quote ID
string
the proposal id of the request
Path:
Quote ID

WorkOrder Closed

Operation ID:
WorkOrder-Closed

triggers when a workorder is closed

Required Parameters

Specify the campaign ID
integer
Campaign ID
Key:
PromotionID

Returns

Work Order Number
string
Work Order Number
Path:
Work Order Number

WorkOrder Created

Operation ID:
WorkOrder-Created

triggers when a workorder is created

Required Parameters

Specify the campaign ID
integer
Campaign ID
Key:
PromotionID

Returns

Work Order Number
string
Work Order Number
Path:
Work Order Number

WorkOrder Status Changed

Operation ID:
WorkOrder-Status-Changed

triggers when the status of the workorder has changed

Required Parameters

The desired WO Status
string
Enter WO Status Text
Key:
Status

Returns

Work Order Number
string
Work Order Number
Path:
Work Order Number

WorkOrder is Past Due

Operation ID:
WorkOrder-Past-Due

triggers when a workorder is past the due date

Required Parameters

Specify the campaign ID
integer
Campaign ID
Key:
PromotionID

Returns

Work Order Number
string
Work Order Number
Path:
Work Order Number