Suggest Relationships for Interaction Type (Hub)

[This topic is pre-release documentation and is subject to change.]

Suggests Relationships for the specified Interaction type. These suggestions can be subsequently used to create RelationshipLinks. Relationships are inferred through property and existing relationship analysis.

Request

The request is constructed as follows:

HTTP Verb Request URI
POST <hub-endpoint>/manage/model/interactions/<interactionName>/suggestRelationshipLinks?api-version=2017-04-26

URI Parameters

URI Parameter Required Description
Hub-endpoint Yes The base URL for your Customer Insights Hub
interactionName Yes Name of the interaction to process

Response

The response includes a standard HTTP status code, a set of standard response headers, and a response body.

Response Body

The returned value contains the interaction name and an array of suggested relationships, of the form:

{
  "interactionName": "string",
  "suggestedRelationships": [
    {
      "profileName": "string",
      "profilePropertyReferences": [
        {
          "interactionPropertyName": "string",
          "profilePropertyName": "string"
        }
      ],
      "relatedProfileName": "string",
      "relatedProfilePropertyReferences": [
        {
          "interactionPropertyName": "string",
          "profilePropertyName": "string"
        }
      ],
      "existingRelationshipName": "string"
    }
  ]
}