Create or Update Relationship Link (ARM)

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

Creates a new or updates an existing RelationshipLink in the specified Customer Insights Hub.


The request is constructed as follows:

HTTP Verb Request URI

URI Parameters

URI Parameter Required Description
subId Yes The Azure subscription ID
rgName Yes The resource group name
hubName Yes Name of your Customer Insights Hub
relationshipLinkName Yes The name of the relationship link to create or update

Request Body

The body must supply the required properties of the RelationshipLink type, for example:

    "description": {
        "en-us": "Link Description"
    "displayName": {
        "en-us": "Link DisplayName"
    "interactionType": "testInteraction4332",
    "linkName": "testlink002",
    "profilePropertyReferences": [{
        "interactionPropertyName": "profile1",
        "profilePropertyName": "ProfileId"
    "provisioningState": "Provisioning",
    "relatedProfilePropertyReferences": [{
        "interactionPropertyName": "profile1",
        "profilePropertyName": "ProfileId"
    "relationshipName": "testProfile2326994",
    "tenantId": "sdktesthub"


The response includes an HTTP status code and a standard set of response headers. Upon success, the body will contain information about the newly created relationship in the following form:

    "id": <relationshipUrl>, 
    "name": <relationshipName>, 
    "type": "Microsoft.CustomerInsights/hubs/relationshipLinks",
    "properties": { <relationshipLinkProperties> }

Status Code

  • 200 (OK) - the update request completed successfully.
  • 202 (Accepted) - the request was accepted and is pending.
  • 400 (Bad Request) - Validation fails or invalid JSON.