Batch Profiles

A POST to the /profiles/batch allows your application to create/update multiple profiles at once, by providing a list of profiles to batch process

Batch updating or creating profiles

This endpoint allows developers to create or update multiple profiles at once.
This can be useful for one-off or incremental imports to Omneo.
It is not recommended to use Batch importing to save on API calls, as these profiles will be added to a queue, and are subject to the workload of other jobs in the queue.

Because this process is added as a background process, the results of these profiles are not available as an API response. Instead, when a profile is successfully updated or create the appropriate profile.updated or profile.created webhook event will be triggered.

Attribute	Description
profiles ARRAY	An array of Profile Objects. Omneo will use each record in this array to create or update an omneo profile based on the match_criteria
match_criteria STRING	The criteria to match the batch members with existing Omneo profiles. Specify 'email' to match by email. Or specify an identity handle

Specifying a match_criteria

The match_criteria is used to match members in your batch, to existing Omneo Profiles.
If no profile is found using this criteria, a new Omneo profile will be created instead.

Match criteria can be:
"email" which will attempt to match the email specified in your profile batch

A simple batch import matching by email could look like the below:

JSON

{
    "match_criteria": "email",
    "profiles" : [
        {
            "email" : "[email protected]",
            "first_name" : "John", 
            "last_name" : "Smith", 
          	"gender": "male"
        },
        {
            "email" : "[email protected]",
            "first_name" : "Jim", 
            "last_name" : "Jones"
        }
    ]
}

Any other value will attempt to match within your profile batch's identities by the handle

To match profiles by a specified identifier against the profile, simply specify the name of the identity handle in the match_criteria

Omneo will search for the value in your batch profiles[].identities array.
And will attempt to match an Omneo profile with a matching identity.

JSON

{
    "match_criteria": "shopify_id",
    "profiles" : [
        {
            "email" : "[email protected]",
            "first_name" : "Johnny", 
            "last_name" : "James",
            "identities" : [
                {
                    "handle" : "shopify_id",
                    "identifier" : "01F3P90M3PCTE22QYJ5NZWVZQ3"
                }
            ]
        }
    ]
}