Response Bodies

Learn more about the available response bodies of AI Relationship Research APIs.

Confirm CRM Match

Output representation of the updated CRM match and resolution information for the specified object after the match confirmation, override, or rejection is processed. The response includes the object’s current resolution status, CRM match details, and links for retrieving the updated relationship insight.
CRM Match Detail

Output representation that contains information about the CRM record matched to the object, including the matched record ID, record type, and match source.
CRM Match Object

Output representation for the CRM match operation. Contains the object’s updated resolution status, CRM match information, and related links for retrieving the updated relationship insight.
CRM Match Links

Output representation that contain links related to the CRM match update, including a self link and a link to the associated relationship insight.
Dismiss Relationship

Output representation that contains information about the dismissed relationship and links to retrieve the associated relationship insight.
Generate Relationship Insights

Output representation that contains the relationship insight generation details and links to related resources.
Get Relationship Insights

Output representation of the full viewable insight graph.
Get Relationship Insights Job Status

Output representation that contains information about the relationship insight generation job and links to related resources.
RRA Entity

Output representation that contains information about an object in the relationship insight graph.
RRA Insight Graph

Output representation of graph payload, such as nodes and edges for UI rendering.
RRA Insight Header

Header metadata for an insight (maps to RRAInsight).
RRA Insight Source

Output representation of source details that’s used to derive a relationship. Source provenance maps to RRAInsightSource.
RRA Insight Target

Output representation details of the target record metadata for the insight.
RRA Job Error

Output representation of error details gated by includeDiagnostics and caller permissions.
RRA Job Links

Hypermedia links for job status and insight retrieval.
RRA Job Progress

Output representation that contains progress information for the relationship insight generation job.
RRA Job Result

Result pointer when job completes.
RRA Links

Hypermedia links for related actions or resources.
RRA Rel Evidence

Output representation of evidence that supports a relationship. Evidence maps to RRARelEvidence.
RRA Relationship

Output representation that contains information about a relationship between objects in the relationship insight graph. Relationship edge maps to RRARelationship, optionally projected to FlexibleHierarchyNodeRela.