About
Description Here
Configurations
Name Description Method Path Parameters Results Variables
PATCH Update Columns for HubDB table PATCH cms/v3/hubdb/tables/$tableName/draft {} [tableName, col]
GET ticket by ID Get ticket GET crm/v3/objects/tickets/$ticketId {} [ticketId]
POST Create Company POST crm/v3/objects/companies {companyID={value=body.properties.hs_object_id}} [CompanyName, CompanyDomain, industry]
GET Company by ID GET crm/v3/objects/companies/$id {HSCompanyID={value=body.properties['hs_object_id']}, HSCompanyName={value=body.properties['name']}, HSCompanyURL={value=body.properties['website']}} [id]
GET Ticket with Associations GET crm/v3/objects/tickets/$ticketId {associations={value=body.associations}, subject={value=body.properties.subject}} [ticketId]
GET FileFolder GET files/v3/folders/$folderId {} [folderId]
GET Contact by ID GET crm/v3/objects/contacts/$id {properties={value=body.properties}} [id]
POST Get tickets last 10 minutes POST crm/v3/objects/tickets/search {results={value=body.results}} [search]
POST Get Partners POST crm/v3/objects/companies/search {Partner={children={name=current.properties.name}, value=body.results}} []
GET Lead by ID GET crm/v3/objects/leads/$leadID {properties={value=body.properties}} [leadID]
Search companies POST crm/v3/objects/companies/search {Companies={children={id=current.id, name=current.properties.name}, value=body.results}} [search]
GET association between two objects GET /crm/v4/objects/$fromObjectType/$objectId/associations/$toObjectType {} [fromObjectType, objectId, toObjectType]
GET File by ID GET files/v3/files/$fileID {body={value=body}} [fileID]
DELETE Lead by ID DELETE crm/v3/objects/leads/$leadId {} [leadId]
POST Create Lead with association to primary contact POST crm/v3/objects/leads {leadID={value=body.id}} [objectIDtoAssociateTo, leadName, leadType, leadLabel, submittingPartner, LeadOwnerID]
POST Create Contact with Association POST crm/v3/objects/contacts {contactID={value=body.id}, properties={value=body.properties}} [email, firstname, lastname, company, companyid, associationcategory, associationtypeid]
GET Deal by ID GET crm/v3/objects/deals/$dealID {} [dealID]
GET Retrieve Label assocations GET crm/v4/associations/$fromObjectType/$toObjectType/labels {} [fromObjectType, toObjectType]
PUT associate object to another object PUT crm/v4/objects/$objectType/$objectId/associations/default/$toObjectType/$toObjectId {} [objectType, objectId, toObjectType, toObjectId]
GET all property options of an object GET crm/v3/properties/$object/$propertyName {values={children={displayOrder=current.displayOrder, name=current.label, value=current.value}, value=body.options}} [object, propertyName]
POST Create Folder with path POST files/v3/folders {} [parentPath, folderName]
PUT associate object to another with label PUT crm/v4/objects/$objectType/$objectId/associations/$toObjectType/$toObjectId {} [objectType, objectId, toObjectType, toObjectId, associationCategory, associationTypeId]
GET Leads GET crm/v3/objects/leads {results={value=body.results}} []
GET Deals GET crm/v3/objects/deals {results={value=body.results}} []
POST HubDB Table PATCH cms/v3/hubdb/tables/$tableID/draft {} [tableID]
GET HubDB Table GET cms/v3/hubdb/tables/$tableID/draft {} [tableID]
GET Note by ID GET crm/v3/objects/notes/$noteId {} [noteId]
GET Owner by Email GET crm/v3/owners/ {} [ownerEmail]
POST Create note with association to company POST crm/v3/objects/notes {} [timestamp, noteBody, ownerID, attachmentIDs, companyID]
POST Search company by Domain POST companies/v2/domains/$domain/companies {results={value=body.results[0]}} [domain]
GET lifecycle stages for contacts GET crm/v3/properties/contacts/lifecyclestage {stages={children={label=current.label, value=current.value}, value=body.options}} []
GET properties of itemtype GET crm/v3/properties/$itemType {results={children={description=current.description, groupName=current.groupName, label=current.label, name=current.name}, value=body.results}} [itemType]
PATCH Lead property value PATCH crm/v3/objects/leads/$leadsId {} [leadsId, propertyid, propertyvalue]
POST Create Deal with association to object POST crm/v3/objects/deals {DealID={value=body.properties['hs_object_id']}, properties={value=body.properties}} [dealAmount, closeDate, dealName, pipeline, dealStage, ownerID, associateToID, associationTypeID]
POST Get Contact by Email POST crm/v3/objects/contacts/search {user={children={FullName=current.properties.firstname + " " + current.properties.lastname, email=current.properties.email, id=current.id}, value=body.results[0]}} [email]
PATCH Update Deal PATCH crm/v3/objects/deals/$dealId {} [dealId, attribute, attributeValue]
Download GitHub

On This Page

Looking for a workflow engine? Learn more about the Kinetic Data Enterprise Workflow Platform. Check it out
Return to Top