Guides
Signup For Free

SalesForce API Integration

Suggest Edits

These are the list of integration use cases supported by Knit for SalesForce API as part of the CRM category

Delete a contact or person

  • ID: delete_a_contact_or_person
  • Operation:
  • Entities:
  • Summary: The 'Delete a contact or person' API allows you to delete a contact from the Salesforce database. The API requires the 'contactId' as a path parameter, which is the unique identifier of the contact to be deleted. The request does not require a body or query parameters. Headers are optional, and an OAuth 2 token header is not required if you are working through knit. The response will have no body, indicating a successful deletion.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete a deal or opportunity

  • ID: delete_a_deal_or_opportunity
  • Operation:
  • Entities:
  • Summary: This API deletes a specific deal or opportunity in Salesforce. The request requires the 'dealId' as a path parameter to identify which deal or opportunity to delete. The request headers can include authorization and other headers if needed, but OAuth 2 token header is not required if working through knit. The response does not contain a body, and any headers in the response will appear in the headers section.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete a lead

  • ID: delete_a_lead
  • Operation:
  • Entities:
  • Summary: The 'Delete a lead' API allows you to delete a lead from Salesforce using the DELETE method. The API requires the 'leadId' as a path parameter to identify the lead to be deleted. Headers can include authorization details, but OAuth 2 token header is not required if working through knit. There are no query parameters or request body required for this API. The response does not include a body, and any headers in the response will appear in the headers section.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete an account or company

  • ID: delete_an_account_or_company
  • Operation:
  • Entities:
  • Summary: The 'Delete an account or company' API is used to delete an account or company from the Salesforce database. The API requires the account ID as a path parameter to identify which account to delete. The request does not require any headers unless specified, and OAuth 2 token header is not required if working through knit. There are no query parameters or request body needed. The response does not include a body, and any headers in the response will be included in the headers section.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete an engagement

  • ID: delete_an_engagement
  • Operation:
  • Entities:
  • Summary: The 'Delete an engagement' API allows users to delete a specific engagement in Salesforce by providing the engagement ID in the path parameters. The request does not require a body and typically does not return any content in the response body. Headers may include authorization details, although OAuth 2 token headers are not required if using knit. The response will have headers if applicable, but the body will be null.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Query

Get Oppurtunity From ID

  • ID: get_deal_from_id
  • Operation: read
  • Entities:
  • Summary: This API endpoint retrieves a deal from an ID.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get list of accounts or companies

  • ID: get_list_of_accounts_or_companies
  • Operation:
  • Entities:
  • Summary: The 'Get list of accounts or companies' API retrieves a list of account or company records from Salesforce. It uses the GET method and requires the URL 'https://{{subDomain}}.saleforce.com/services/data/v60.0/query/'. The API accepts optional query parameters 'limit' and 'offset' to control the number of records returned and their starting point. The response includes a 'totalSize' indicating the total number of records, a 'done' flag indicating if the query is complete, and an array of 'records' containing detailed information about each account or company, including attributes like 'Id', 'Name', 'Owner', 'CreatedBy', and various address and contact details. The API does not require an OAuth 2 token if accessed through knit.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get list of calls

  • ID: get_list_of_calls
  • Operation:
  • Entities:
  • Summary: The 'Get list of calls' API retrieves a list of call records from Salesforce. It uses the GET method and requires the URL 'https://{{subDomain}}.saleforce.com/services/data/v60.0/query/'. The API accepts optional query parameters 'limit' and 'offset' to control the number of records returned and the starting point of the records array, respectively. The headers may include an 'Authorization' token, although it is not required if working through knit. The response includes a 'totalSize' indicating the total number of records, a 'done' flag indicating if the query is complete, and an array of 'records' with detailed information about each call, including attributes like 'Id', 'Subject', 'Status', 'Priority', and more. Some fields in the records may be null, such as 'Description', 'Type', and 'CallDurationInSeconds'.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get list of contacts or persons

  • ID: get_list_of_contacts_or_persons
  • Operation:
  • Entities:
  • Summary: The 'Get list of contacts or persons' API retrieves a list of contact records from Salesforce. It uses the GET method and requires the subdomain to be specified in the URL. The API accepts optional query parameters 'limit' and 'offset' to control the number of records returned and their starting point. The response includes a 'totalSize' indicating the total number of records, a 'done' flag to indicate if the query is complete, and an array of 'records' containing detailed information about each contact, such as their name, email, phone numbers, addresses, and other attributes. The API also provides metadata about the owner and creator of each contact.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get list of deals or opportunities

  • ID: get_list_of_deals_or_opportunities
  • Operation:
  • Entities:
  • Summary: The 'Get list of deals or opportunities' API retrieves a list of opportunities from Salesforce. It uses the GET method and requires the subdomain to be specified in the URL. The API accepts optional query parameters 'limit' and 'offset' to control pagination. The response includes the total number of records, a completion status, and an array of opportunity records. Each record contains detailed information about the opportunity, including attributes, owner, creator, and various opportunity-specific fields such as stage, amount, and close date.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get list of emails

  • ID: get_list_of_emails
  • Operation:
  • Entities:
  • Summary: The 'Get list of emails' API retrieves a list of email-related tasks from Salesforce. It uses a GET method to query the Salesforce database and returns a list of tasks with details such as task ID, subject, status, priority, and more. The API accepts optional query parameters 'limit' and 'offset' to control the number of records returned and their starting point. The response includes metadata about each task, including attributes like type, URL, and various task-specific fields. The API is designed to work with OAuth 2 token headers, although this is not required if accessed through knit.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get list of engagements

  • ID: get_list_of_engagements
  • Operation:
  • Entities:
  • Summary: The 'Get list of engagements' API retrieves a list of engagement records from Salesforce. It uses the GET method and requires the endpoint URL 'https://{{subDomain}}.saleforce.com/services/data/v60.0/query/'. The API accepts optional query parameters 'limit' and 'offset' to control the number of records returned and the starting point of the records, respectively. The headers may include an 'Authorization' token, but it is not required if working through knit. The response includes a 'totalSize' indicating the total number of records, a 'done' flag indicating if the query is complete, and an array of 'records' with detailed information about each engagement, such as 'Id', 'Subject', 'Status', 'Priority', and more. Some fields in the records may be null, indicating that the information is not available.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get list of leads

  • ID: get_list_of_leads
  • Operation:
  • Entities:
  • Summary: The 'Get list of leads' API retrieves a list of lead records from Salesforce. It uses the GET method and requires an OAuth 2 token for authorization, unless accessed through knit. The API accepts query parameters 'limit' and 'offset' to control pagination. The response includes the total number of records, a completion status, and an array of lead records with detailed information such as owner, creator, contact details, address, and other lead-specific attributes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get list of meetings

  • ID: get_list_of_meetings
  • Operation:
  • Entities:
  • Summary: The 'Get list of meetings' API retrieves a list of meeting records from Salesforce. It uses a GET method to query the Salesforce database. The API accepts optional query parameters 'limit' and 'offset' to control the number of records returned and the starting point of the records, respectively. The response includes a 'totalSize' indicating the total number of records, a 'done' flag indicating if the query is complete, and an array of 'records' containing detailed information about each meeting, such as 'Id', 'Subject', 'ActivityDate', 'Status', and more. Some fields in the records may be null, indicating that the information is not available.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update a contact or person

  • ID: patch_update_a_contact_or_person
  • Operation:
  • Entities:
  • Summary: The 'Update a contact or person' API allows you to update the details of an existing contact in Salesforce. You need to provide the contact's unique identifier in the path parameters. The request body can include fields such as firstName, lastName, email, description, title, ownerId, phone, and address details. The address is an object containing fields like addressLine1, addressLine2, city, state, country, zipCode, and type. The Authorization header is optional if you are working through knit. The API returns a null body, indicating that no content is returned upon a successful update.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update a deal or opportunity

  • ID: patch_update_a_deal_or_opportunity
  • Operation:
  • Entities:
  • Summary: This API updates a deal or opportunity in Salesforce. It requires the deal ID as a path parameter. The request can include headers, though OAuth 2 token headers are not required if using knit. The body of the request includes details such as the name, description, amount, owner ID, owner email, stage ID, account ID, contact ID, and close date of the deal or opportunity. The response includes headers and a null body if the update is successful.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update a lead

  • ID: patch_update_a_lead
  • Operation:
  • Entities:
  • Summary: The 'Update a lead' API allows you to update the details of an existing lead in Salesforce. You need to provide the lead's unique identifier in the path parameters. The request body can include various fields such as first name, last name, owner details, job title, company, description, industry, number of employees, address, email, phone, status, and website. The Authorization header is optional if you are working through knit. The response does not return any content in the body.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update an account or company

  • ID: patch_update_an_account_or_company
  • Operation:
  • Entities:
  • Summary: The 'Update an account or company' API allows users to update details of an existing account or company in Salesforce. The API requires the account ID as a path parameter and accepts various fields in the request body, such as name, description, industry, website, number of employees, address, and phone number. The address is a nested object containing fields like addressLine1, addressLine2, city, state, country, zipCode, and type. The API uses the PATCH method and requires an OAuth 2 token for authorization unless accessed through knit. The response does not return any content, indicated by a null body.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update an engagement

  • ID: patch_update_an_engagement
  • Operation:
  • Entities:
  • Summary: The 'Update an engagement' API allows you to update an existing engagement in Salesforce. The API requires the 'engagementId' as a path parameter to identify the engagement to be updated. The request body includes details such as the type, subject, direction, content, owner, status, and channel of the engagement. The 'Authorization' header is optional if you are working through knit. The response does not return any content, and the response body is null.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a contact or person

  • ID: post_create_a_contact_or_person
  • Operation:
  • Entities:
  • Summary: This API endpoint allows the creation of a contact or person in the Salesforce system. It requires the first name, last name, email, and owner ID as mandatory fields in the request body. Optional fields include description, title, phone, and address details. The address can include multiple lines, city, state, country, zip code, and type. The API returns a unique identifier for the created contact, a success flag, and any errors that occurred during the process.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a deal or opportunity

  • ID: post_create_a_deal_or_opportunity
  • Operation:
  • Entities:
  • Summary: This API endpoint allows the creation of a new deal or opportunity in Salesforce. It requires a POST request to the specified URL with a JSON body containing details of the opportunity such as 'name', 'ownerId', 'stageId', and 'closeDate', which are mandatory fields. Optional fields include 'description', 'amount', 'account', and 'contact'. The request may include an 'Authorization' header with an OAuth 2 token unless working through knit. The response includes the 'id' of the created opportunity, a 'success' boolean, and an 'errors' array.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a lead

  • ID: post_create_a_lead
  • Operation:
  • Entities:
  • Summary: The Create a Lead API allows you to create a new lead in the Salesforce system. It requires a POST request to the specified URL with details about the lead in the request body. The request body includes fields such as firstName, lastName, owner, jobTitle, company, description, industry, numberOfEmployees, address, email, phone, status, and website. The company field is required. The API returns a response with the ID of the created lead, a success flag, and any errors that occurred during the creation process.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create an account or company

  • ID: post_create_an_account_or_company
  • Operation:
  • Entities:
  • Summary: The 'Create an account or company' API allows users to create a new account or company in the Salesforce system. The API requires a POST request to the specified URL with a JSON body containing details such as the name, description, industry, website, number of employees, address, and phone number of the account or company. The 'name' field is mandatory. The API returns a response with a unique identifier for the created account or company, a success flag, and any errors encountered during the creation process. Authorization is typically handled via an OAuth 2 token, but this is not required if working through knit.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create an engagement

  • ID: post_create_an_engagement
  • Operation:
  • Entities:
  • Summary: The 'Create an engagement' API allows users to create a new engagement task in Salesforce. The API requires a POST request to the specified URL with a JSON body containing details of the engagement such as type, subject, direction, content, owner, status, and channel. The 'type' field is required and must be one of 'Call', 'Email', 'Meeting', or 'Communication'. The response includes the ID of the created engagement, a success flag, and any errors that occurred during the creation process. Authorization is handled via an OAuth 2 token, which is not required if working through knit.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Updated 5 days ago