Newer Version Available

This content describes an older version of this product. View Latest

Dismiss Relationship (POST)

Dismiss a relationship from a relationship insight. Use this resource to indicate that a relationship is not relevant, incorrect, not actionable, or otherwise must not be shown.
Resource
1/connect/relationship-research/insights/insightId/relationships/relationshipId/dismiss
Resource example
1https://yourInstance.salesforce.com/services/data/v66.0/connect/relationship-research/insights/rra-insight-000456/relationships/rra-rel-100/dismiss
Available version
67.0
HTTP methods
POST
Request body for POST
JSON example
1{
2  "reasonCode": "NOT_RELEVANT",
3  "comment": null,
4  "clientContext": { "surface": "RecordPage", "component": "RraInsightPanel" }
5}
Properties
Name Type Description Required or Optional Available Version
clientContext Map<String, Object> Optional UI context used for telemetry, such as page, component, or sessionId. The system doesn't persist this information in the relationship record. Optional 67.0
comment String Optional note that explains the reason for the dismissal of the relationship. Administrators or support tooling typically use this field. Optional 67.0
reasonCode String Reason to dismiss the relationship. Possible values include:
  • INCORRECT
  • NOT_RELEVANT
  • DUPLICATE
  • SENSITIVE
  • OTHER
Optional 67.0
Response body for POST
Dismiss Relationship