Skip to content

Source of an attribute

Preview

This feature is not subject to our service terms. Pre-GA features are available as is and might have limited support.

For every individual attribute provided by your application, such as a phone number or email address, you can also provide a reference to the original source of the data point. Modigie will return these values as is. This enables your application to efficiently process the job result because it can safely determine which exact record and field it needs to add, update, or delete.

Tip

When the real-time engine appends an attribute that was not already provided by your application, Modigie will not set the source for that attribute. Therefore, it is highly recommended that your application sets at least one of the source properties, such as objectSystem="my-app", so it can clearly identify attributes you provided as input.

Schema

source is an optional and nullable property of type JobV2Source objects, available to select input values.

Each JobV2Source object has four properties, and all are optional:

objectId: string optional
The unique ID of this record that your application uses to identify which record this data point belongs to. Modigie will return this value as is. Example: "00Q1U00000X3nidUAB"
objectType: string optional
The unique type of this record that your application uses to identify which record this data point belongs to. For example, Lead, Contact, Some_Custom_c, or Prospect_c. Modigie will return this value as is.
objectSystem: string optional
The source system of this record that your application uses to identify which record this data point belongs to. Modigie will return this value as is. Example: "CRM"
propertyName: string optional
The field name of this record that your application uses to identify which property this data point belongs to. Modigie will return this value as is. Example: "business_email_address"

Example

job-request.json
{
  "payload": {
    "person": {
      "source": {
        "objectSystem": null,
        "objectType": null,
        "objectId": "personA",
        "propertyName": "name"
      },
      ...
    },
    ...
  },
  ...
}

In every response message for this job request, Modigie will return the source property as it was provided by your application in the job request.

job-response.json
{
  "payload": {
    "person": {
      "source": {
        "objectSystem": null,
        "objectType": null,
        "objectId": "personA",
        "propertyName": "name"
      },
      ...
    },
    ...
  },
  ...
}

Schema: JobV2Source