Industries Common Resources Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Industries Common Resources
AI Accelerator and Scoring Framework
Action Launcher
Actionable List Members
Actionable Segmentation
Business Rules Engine
Collections and Recovery
Context Service
Criteria-Based Search and Filter
Data Processing Engine, Batch Management, and Monitor Workflow Services
Digital Lending
Discovery Framework
Decision Explainer
Einstein Relationship Insights
Einstein Standard Invocable Actions
Engagement
Group Membership and Households
Identity Verification
Intelligent Document Reader
Intelligent Form Reader
Interest Tagging
Interest Tagging Business APIs
REST Reference
Resources
Interest Tags (DELETE, GET, POST)
Interest Tags (PATCH)
Interest Tag Categories (GET)
Interest Tags for Records (GET)
Interest Tag Assignments (GET)
Assignments for Interest Tags and Records (POST)
Request Bodies
Response Bodies
Omnistudio Business APIs
Outcome Management Developer Guide
Outreach List
Process Compliance Navigator
Record Alerts
Record Rollup Definitions
Scheduled Reminders
Sentiment Insights
Service Process Studio
Timeline
Virtual Calls
Associated Objects
IndustriesSettings
Industries Object Access by Community License
Access Industries Features Deployed Using Managed Packages
PDF

Interest Tags (DELETE, GET, POST)

Create an Interest Tag. Delete Interest Tags by the tag IDs. Retrieve a list of Interest Tags by a category ID.
Resource
/connect/interest-tags/tags
Example for DELETE
https://yourInstance.salesforce.com/services/data/vXX.X/connect
/interest-tags/tags?tagId=0qOxx0000004C94EAE,0qOxx0000004C92EAE
Example for GET
https://yourInstance.salesforce.com/services/data/vXX.X/connect
/interest-tags/tags?categoryId=0qRxx0000000001EAA
Example for POST
https://yourInstance.salesforce.com/services/data/vXX.X/connect
/interest-tags/tags
Available version
54.0
Requires Chatter
No
HTTP methods
DELETE, GET, POST
Query parameters for DELETE
Parameter Name Type Description Required or Optional Available Version
tagIds String The list of IDs for the Interest Tags to delete. Required 54.0
Query parameters for GET
Parameter Name Type Description Required or Optional Available Version
categoryId String The category ID assigned to an Interest Tag. Required 54.0
limit Integer The maximum number of Interest Tags to return. Maximum is 100. Optional 54.0
offset Integer The offset for the next set of results. The offset parameter specifies the end of the last batch retrieved. For example, to retrieve 15 Interest Tags at a time:
  • Request the first 15 with an offset of 0.
  • Request the second 15 with an offset of 15.
 Optional 54.0
orderBy String Order the results to display by the category name or Interest Tag ID. Optional 54.0
sort String Sort the results in ascending or descending order. Optional 54.0
Response body for GET
Interest Tag List
Request body for POST
JSON example
{
   "interestTagList":[
      {
         "tagDescription":"Golf",
         "tagName":"Golf",
         "categoryId":"0qRxx0000000001EAA",
         "recordId" : "001xx000003DGQyAAO"
      }
   ]
}
Properties
Name Type Description Required or Optional Available Version
categoryId String The category ID of an Interest Tag. Required 54.0
recordId String ID of the record to assign an Interest Tag. Optional 54.0
tagDescription String The description of an Interest Tag. Optional 54.0
tagName String The unique name of an Interest Tag. Required 54.0
Response body for POST
Interest Tag Create Collection Output