Configure your Salesforce Connector Profile
Learn how to configure your Salesforce connector profile for your Reltio tenant using this endpoint.
You manage data synchronization between Salesforce and the Reltio platform with the Salesforce Connector profile.
Configure or create a Salesforce connector profile to map data fields between the two systems with the endpoint below. For information on configuration endpoints, see topic Salesforce Connector Configuration API
Request
POST {Salesforce connector URL}\configuration\{tenantId}\{profileName}
Use the parameters added for the Request task, listed in Table 1: Request Parameters.
Parameter | Required | Description | |
---|---|---|---|
Headers | Authorization | Yes | The Access Token in format "Bearer . For more information, see Authentication API) |
Content-Type | Yes | The value must be " . | |
Query | tenantId | Yes | Defines the ID of the tenant. |
Query | profileName | Yes | Defines the name of the Profile. If this profile name already exists, the request overwrites the previous profile but retains the original ReltioSQS property . Otherwise it create a new profile. |
Query | generateDefaultMapping | Yes | Defines the default mapping, which is generated. The possible values are true or false. The default value is false. The parameter will be processed only for new profiles. The default mapping may be generated only if tenant contains the source configuration/sources/Salesforce . |
Body | Yes |
|
Use the parameters added for Salesforce profile configuration listed in Table 2: Parameters for Salesforce Profile Configuration.
Parameter | Required | Description |
---|---|---|
statisticsEnable | No | Enables statistics for a tenant and profile. This parameter is set to false by default. Note: The Events API doesn't work if statistics are disabled. |
namespace | No | Defines the name of the namespace. |
loginUrl | Yes | Defines the Salesforce URL. |
user | Yes | Defines the Salesforce service user. |
password | Yes | Defines the Password for a salesforce user. |
pollTime | No | Defines the time in seconds to poll Salesforce for changes. The default value is 300. |
checkFieldsChanged | No |
Determines whether the Reltio Integration for Salesforce generates an event when at least one mapping field is changed in the Salesforce Connector profile:
Note: After you set this parameter, resync the Reltio Integration for Salesforce from Reltio Control panel. Reltio Integration for Salesforce gathers the changed field details, creates an event to synchronize the data between Salesforce and Reltio, and generates a list. |
Use the parameters added for Reltio profile configuration listed in Table 3: Parameters for Reltio Profile configuration.
Parameter | Required | Description |
---|---|---|
tenantUrl | Yes | Defines the URL of the Tenant. |
authUrl | No | Defines the authorization server URL. For more information, see Reltio Integration for Salesforce Profile Validation. |
username | No | Defines the username of the Reltio service users. |
password | No | Defines the password of the Reltio service users. |
authToken | No | Defines an Authentication token. For more information, see Reltio Integration for Salesforce Profile Validation. |
batchSize | No | Defines the number of entities to process at a time. The default value of the parameter is 50. |
maxapicall | No | Defines the maximum number of API requests made to Reltio. |
deltaFiltering | No | If true, the connector only processes events with updates to attributes available in the mapping, ignoring the events with no updates to mapped attributes. The default value of the parameter false. |
Parameter | Required | Description |
---|---|---|
No | Defines a valid email for sending the notifications.The connector supports email notifications about connection problems and/or configuration changes for specific profiles. | |
reportConnection | No | Defines the values depending upon which the connector sends the emails. If the value of the parameter is true, the connector sends the emails regarding the connection problems to the profile owner. This is an optional parameter. By default, the parameter is set to false. |
reportProfileChanges | No | Depending upon the value of this parameter, the connector sends the emails regarding the changes in the profile configuration. If the value of the parameter is true, the connector sends the emails for the changes in the profile configuration settings ( |
logSyncErrors | No | Enables Reltio for logging Salesforce synchronization errors. This is an optional parameter. The possible values of the parameter are true and false. By default, the value of the parameter is false. |
logSyncErrorsToActivityLog | No | Activates reporting to the Reltio Activity Log. It allows you to notify the tenant and particular entity in case of synchronization. By default, the value of the parameter is set as false. |
Response
Success: 200 status: {profileName} has been updated}
Error: 400 Bad Request, { error: {reason}}
For more information, see Salesforce Connector API Error Codes.