Skip to main content
POST
/
v3
/
profiles
/
batch
Batch Profiles
curl --request POST \
  --url http://localhost/api/v3/profiles/batch \
  --header 'Content-Type: application/json' \
  --data '
{
  "match_criteria": "<string>",
  "profiles": [
    {
      "first_name": "<string>",
      "last_name": "<string>",
      "email": "jsmith@example.com",
      "title": "<string>",
      "gender": "male",
      "currency": "<string>",
      "profile_type": "temporary",
      "joined_at": "2023-11-07T05:31:56Z",
      "mobile_phone": "<string>",
      "secondary_phone": "<string>",
      "birth_day": 123,
      "birth_month": 123,
      "birth_year": 123,
      "company": "<string>",
      "occupation": "<string>",
      "avatar_url": "<string>",
      "joined_location_id": 123,
      "joined_location_external_id": "<string>",
      "joined_location_external_code": "<string>",
      "preferred_location_id": 123,
      "preferred_location_external_id": "<string>",
      "preferred_location_external_code": "<string>",
      "tags": [
        "<string>"
      ],
      "identities": [
        {
          "handle": "<string>",
          "identifier": "<string>",
          "is_active": true
        }
      ],
      "custom_attributes": [
        {
          "namespace": "<string>",
          "handle": "<string>",
          "type": "string",
          "value": "<string>"
        }
      ],
      "dates_attributes": [
        {
          "date": "2023-12-25",
          "name": "<string>",
          "handle": "<string>",
          "is_recurring": true,
          "recurring_schedule": "<string>",
          "meta": [
            "<string>"
          ],
          "note": "<string>",
          "description": "<string>",
          "relationship": "<string>",
          "role": "<string>",
          "links": [
            {
              "profile_id": "<string>",
              "relationship": "<string>",
              "role": "<string>"
            }
          ]
        }
      ],
      "statuses": [
        "<string>"
      ],
      "addresses": [
        {
          "address_line_1": "<string>",
          "city": "<string>",
          "postcode": "<string>",
          "country": "<string>",
          "address_line_2": "<string>",
          "address_line_3": "<string>",
          "company": "<string>",
          "state": "<string>",
          "notes": "<string>",
          "is_default": true,
          "external_id": "<string>",
          "meta": [
            "<string>"
          ],
          "iso": "<string>",
          "iso_state": "<string>"
        }
      ],
      "comms_attributes": {
        "sms_promo": true,
        "email_promo": true,
        "email_bounced": true,
        "email_benefits": true,
        "email_consent_updated_at": "2023-11-07T05:31:56Z",
        "sms_consent_updated_at": "2023-11-07T05:31:56Z"
      },
      "region_id": 123,
      "region": "<string>",
      "region_country": "<string>",
      "region_state": "<string>",
      "regions": [
        {
          "region_id": 123,
          "handle": "<string>",
          "is_active": true,
          "country": "<string>",
          "state": "<string>"
        }
      ],
      "organisations": [
        {
          "id": 123,
          "role_definition_id": 123,
          "expires_at": "2023-11-07T05:31:56Z",
          "is_active": true
        }
      ],
      "attributes": {
        "comms": {
          "email_consent_updated_at": "2023-11-07T05:31:56Z",
          "sms_consent_updated_at": "2023-11-07T05:31:56Z"
        },
        "appearance": [
          "<string>"
        ]
      }
    }
  ],
  "import_job_id": "<string>"
}
'
{
  "data": {
    "message": "<string>",
    "batch_id": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.omneo.io/llms.txt

Use this file to discover all available pages before exploring further.

​
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.
AttributeDescription
profiles ARRAYAn 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 STRINGThe 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: 
{
    "match_criteria": "email",
    "profiles" : [
        {
            "email" : "demoemail1@gmail.com",
            "first_name" : "John",
            "last_name" : "Smith",
            "gender": "male"
        },
        {
            "email" : "demoemail2@gmail.com",
            "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. 
{
    "match_criteria": "shopify_id",
    "profiles" : [
        {
            "email" : "newemail@omneo.io",
            "first_name" : "Johnny",
            "last_name" : "James",
            "identities" : [
                {
                    "handle" : "shopify_id",
                    "identifier" : "01F3P90M3PCTE22QYJ5NZWVZQ3"
                }
            ]
        }
    ]
}

Body

application/json
​
match_criteria
string
required
​
profiles
object[]
required
Required array length: 1 - 500 elements
​
import_job_id
string

Response

​
data
object
required