Attribute Synchronization and Target Mapping

You must get the source ID before synchronizing attributes. The source ID is displayed at the end of the source's URL in your browser. The source ID is also known as the source's front-end ID for a source. For more information, refer to Best Practices: Attribute Sync.

Important
Ensure that the attribute you are going to add for synchronization is added on the source schema attribute list. Additionally, ensure that the proper identity attribute is mapped with it.

Get and Set the Attribute Synchronization Mapping

Use the Update Attribute Sync Config API to set the attribute.

  1. Make a GET request with the following command:

    GET <url>/sources/<source_ID>/attribute-sync-config

  2. Set the target value with the following command:

    PUT <url>/sources/<sourceID>/attribute-sync-config

The following is an example body for the supported attribute:

Copy 
    "attributes":
     [
     {
            "enabled": true,
            "displayName": "att_email",
            "name": "email",
            "target": "emailAddress"
    },
     {
            "enabled": true,
            "displayName": "UKGLastName",
            "name": "ukglastname",
            "target": "lastName"
        },
        {
            "enabled": true,
            "displayName": "UKGFIRSTNAME",
            "name": "ukgfirstname",
            "target": "firstName"
        },
        {
            "enabled": true,
            "displayName": "MiddleName",
            "name": "middlename",
            "target": "middleName"
        },
        {
            "enabled": true,
            "displayName": "preferredName",
            "name": "preferredname",
            "target": "preferredName"
        }   ,
        {
            "enabled": true,
            "displayName": "suffix",
            "name": "suffix",
            "target": "suffix"
        } ,
        {
            "enabled": true,
            "displayName": "prefix",
            "name": "prefix",
            "target": "prefix"
        }   ,
        {
            "enabled": true,
            "displayName": "ukgalternateEmailAddress",
            "name": "ukgalternateemailaddress",
            "target": "alternateEmailAddress"
        }   

    ],
    "source": {
        "type": "SOURCE",
        "id": "ee2c32b5fa794cd98f702122ac649d9d",
        "name": null
    }
}