Batch Profiles
curl --request POST \
--url https://api.{tenant}.getomneo.com/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>",
"currency": "<string>",
"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>",
"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>"
}
'import requests
url = "https://api.{tenant}.getomneo.com/api/v3/profiles/batch"
payload = {
"match_criteria": "<string>",
"profiles": [
{
"first_name": "<string>",
"last_name": "<string>",
"email": "jsmith@example.com",
"title": "<string>",
"currency": "<string>",
"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>",
"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>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
match_criteria: '<string>',
profiles: [
{
first_name: '<string>',
last_name: '<string>',
email: 'jsmith@example.com',
title: '<string>',
currency: '<string>',
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>', 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>'
})
};
fetch('https://api.{tenant}.getomneo.com/api/v3/profiles/batch', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.{tenant}.getomneo.com/api/v3/profiles/batch",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'match_criteria' => '<string>',
'profiles' => [
[
'first_name' => '<string>',
'last_name' => '<string>',
'email' => 'jsmith@example.com',
'title' => '<string>',
'currency' => '<string>',
'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>',
'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>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.{tenant}.getomneo.com/api/v3/profiles/batch"
payload := strings.NewReader("{\n \"match_criteria\": \"<string>\",\n \"profiles\": [\n {\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"title\": \"<string>\",\n \"currency\": \"<string>\",\n \"joined_at\": \"2023-11-07T05:31:56Z\",\n \"mobile_phone\": \"<string>\",\n \"secondary_phone\": \"<string>\",\n \"birth_day\": 123,\n \"birth_month\": 123,\n \"birth_year\": 123,\n \"company\": \"<string>\",\n \"occupation\": \"<string>\",\n \"avatar_url\": \"<string>\",\n \"joined_location_id\": 123,\n \"joined_location_external_id\": \"<string>\",\n \"joined_location_external_code\": \"<string>\",\n \"preferred_location_id\": 123,\n \"preferred_location_external_id\": \"<string>\",\n \"preferred_location_external_code\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"identities\": [\n {\n \"handle\": \"<string>\",\n \"identifier\": \"<string>\",\n \"is_active\": true\n }\n ],\n \"custom_attributes\": [\n {\n \"namespace\": \"<string>\",\n \"handle\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"dates_attributes\": [\n {\n \"date\": \"2023-12-25\",\n \"name\": \"<string>\",\n \"handle\": \"<string>\",\n \"is_recurring\": true,\n \"recurring_schedule\": \"<string>\",\n \"meta\": [\n \"<string>\"\n ],\n \"note\": \"<string>\",\n \"description\": \"<string>\",\n \"relationship\": \"<string>\",\n \"role\": \"<string>\",\n \"links\": [\n {\n \"profile_id\": \"<string>\",\n \"relationship\": \"<string>\",\n \"role\": \"<string>\"\n }\n ]\n }\n ],\n \"statuses\": [\n \"<string>\"\n ],\n \"addresses\": [\n {\n \"address_line_1\": \"<string>\",\n \"city\": \"<string>\",\n \"postcode\": \"<string>\",\n \"country\": \"<string>\",\n \"address_line_2\": \"<string>\",\n \"address_line_3\": \"<string>\",\n \"company\": \"<string>\",\n \"state\": \"<string>\",\n \"notes\": \"<string>\",\n \"is_default\": true,\n \"external_id\": \"<string>\",\n \"meta\": [\n \"<string>\"\n ],\n \"iso\": \"<string>\",\n \"iso_state\": \"<string>\"\n }\n ],\n \"comms_attributes\": {\n \"sms_promo\": true,\n \"email_promo\": true,\n \"email_bounced\": true,\n \"email_benefits\": true,\n \"email_consent_updated_at\": \"2023-11-07T05:31:56Z\",\n \"sms_consent_updated_at\": \"2023-11-07T05:31:56Z\"\n },\n \"region_id\": 123,\n \"region\": \"<string>\",\n \"region_country\": \"<string>\",\n \"region_state\": \"<string>\",\n \"regions\": [\n {\n \"region_id\": 123,\n \"handle\": \"<string>\",\n \"is_active\": true,\n \"country\": \"<string>\",\n \"state\": \"<string>\"\n }\n ],\n \"organisations\": [\n {\n \"id\": 123,\n \"role_definition_id\": 123,\n \"expires_at\": \"2023-11-07T05:31:56Z\",\n \"is_active\": true\n }\n ],\n \"attributes\": {\n \"comms\": {\n \"email_consent_updated_at\": \"2023-11-07T05:31:56Z\",\n \"sms_consent_updated_at\": \"2023-11-07T05:31:56Z\"\n },\n \"appearance\": [\n \"<string>\"\n ]\n }\n }\n ],\n \"import_job_id\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.{tenant}.getomneo.com/api/v3/profiles/batch")
.header("Content-Type", "application/json")
.body("{\n \"match_criteria\": \"<string>\",\n \"profiles\": [\n {\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"title\": \"<string>\",\n \"currency\": \"<string>\",\n \"joined_at\": \"2023-11-07T05:31:56Z\",\n \"mobile_phone\": \"<string>\",\n \"secondary_phone\": \"<string>\",\n \"birth_day\": 123,\n \"birth_month\": 123,\n \"birth_year\": 123,\n \"company\": \"<string>\",\n \"occupation\": \"<string>\",\n \"avatar_url\": \"<string>\",\n \"joined_location_id\": 123,\n \"joined_location_external_id\": \"<string>\",\n \"joined_location_external_code\": \"<string>\",\n \"preferred_location_id\": 123,\n \"preferred_location_external_id\": \"<string>\",\n \"preferred_location_external_code\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"identities\": [\n {\n \"handle\": \"<string>\",\n \"identifier\": \"<string>\",\n \"is_active\": true\n }\n ],\n \"custom_attributes\": [\n {\n \"namespace\": \"<string>\",\n \"handle\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"dates_attributes\": [\n {\n \"date\": \"2023-12-25\",\n \"name\": \"<string>\",\n \"handle\": \"<string>\",\n \"is_recurring\": true,\n \"recurring_schedule\": \"<string>\",\n \"meta\": [\n \"<string>\"\n ],\n \"note\": \"<string>\",\n \"description\": \"<string>\",\n \"relationship\": \"<string>\",\n \"role\": \"<string>\",\n \"links\": [\n {\n \"profile_id\": \"<string>\",\n \"relationship\": \"<string>\",\n \"role\": \"<string>\"\n }\n ]\n }\n ],\n \"statuses\": [\n \"<string>\"\n ],\n \"addresses\": [\n {\n \"address_line_1\": \"<string>\",\n \"city\": \"<string>\",\n \"postcode\": \"<string>\",\n \"country\": \"<string>\",\n \"address_line_2\": \"<string>\",\n \"address_line_3\": \"<string>\",\n \"company\": \"<string>\",\n \"state\": \"<string>\",\n \"notes\": \"<string>\",\n \"is_default\": true,\n \"external_id\": \"<string>\",\n \"meta\": [\n \"<string>\"\n ],\n \"iso\": \"<string>\",\n \"iso_state\": \"<string>\"\n }\n ],\n \"comms_attributes\": {\n \"sms_promo\": true,\n \"email_promo\": true,\n \"email_bounced\": true,\n \"email_benefits\": true,\n \"email_consent_updated_at\": \"2023-11-07T05:31:56Z\",\n \"sms_consent_updated_at\": \"2023-11-07T05:31:56Z\"\n },\n \"region_id\": 123,\n \"region\": \"<string>\",\n \"region_country\": \"<string>\",\n \"region_state\": \"<string>\",\n \"regions\": [\n {\n \"region_id\": 123,\n \"handle\": \"<string>\",\n \"is_active\": true,\n \"country\": \"<string>\",\n \"state\": \"<string>\"\n }\n ],\n \"organisations\": [\n {\n \"id\": 123,\n \"role_definition_id\": 123,\n \"expires_at\": \"2023-11-07T05:31:56Z\",\n \"is_active\": true\n }\n ],\n \"attributes\": {\n \"comms\": {\n \"email_consent_updated_at\": \"2023-11-07T05:31:56Z\",\n \"sms_consent_updated_at\": \"2023-11-07T05:31:56Z\"\n },\n \"appearance\": [\n \"<string>\"\n ]\n }\n }\n ],\n \"import_job_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.{tenant}.getomneo.com/api/v3/profiles/batch")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"match_criteria\": \"<string>\",\n \"profiles\": [\n {\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"title\": \"<string>\",\n \"currency\": \"<string>\",\n \"joined_at\": \"2023-11-07T05:31:56Z\",\n \"mobile_phone\": \"<string>\",\n \"secondary_phone\": \"<string>\",\n \"birth_day\": 123,\n \"birth_month\": 123,\n \"birth_year\": 123,\n \"company\": \"<string>\",\n \"occupation\": \"<string>\",\n \"avatar_url\": \"<string>\",\n \"joined_location_id\": 123,\n \"joined_location_external_id\": \"<string>\",\n \"joined_location_external_code\": \"<string>\",\n \"preferred_location_id\": 123,\n \"preferred_location_external_id\": \"<string>\",\n \"preferred_location_external_code\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"identities\": [\n {\n \"handle\": \"<string>\",\n \"identifier\": \"<string>\",\n \"is_active\": true\n }\n ],\n \"custom_attributes\": [\n {\n \"namespace\": \"<string>\",\n \"handle\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"dates_attributes\": [\n {\n \"date\": \"2023-12-25\",\n \"name\": \"<string>\",\n \"handle\": \"<string>\",\n \"is_recurring\": true,\n \"recurring_schedule\": \"<string>\",\n \"meta\": [\n \"<string>\"\n ],\n \"note\": \"<string>\",\n \"description\": \"<string>\",\n \"relationship\": \"<string>\",\n \"role\": \"<string>\",\n \"links\": [\n {\n \"profile_id\": \"<string>\",\n \"relationship\": \"<string>\",\n \"role\": \"<string>\"\n }\n ]\n }\n ],\n \"statuses\": [\n \"<string>\"\n ],\n \"addresses\": [\n {\n \"address_line_1\": \"<string>\",\n \"city\": \"<string>\",\n \"postcode\": \"<string>\",\n \"country\": \"<string>\",\n \"address_line_2\": \"<string>\",\n \"address_line_3\": \"<string>\",\n \"company\": \"<string>\",\n \"state\": \"<string>\",\n \"notes\": \"<string>\",\n \"is_default\": true,\n \"external_id\": \"<string>\",\n \"meta\": [\n \"<string>\"\n ],\n \"iso\": \"<string>\",\n \"iso_state\": \"<string>\"\n }\n ],\n \"comms_attributes\": {\n \"sms_promo\": true,\n \"email_promo\": true,\n \"email_bounced\": true,\n \"email_benefits\": true,\n \"email_consent_updated_at\": \"2023-11-07T05:31:56Z\",\n \"sms_consent_updated_at\": \"2023-11-07T05:31:56Z\"\n },\n \"region_id\": 123,\n \"region\": \"<string>\",\n \"region_country\": \"<string>\",\n \"region_state\": \"<string>\",\n \"regions\": [\n {\n \"region_id\": 123,\n \"handle\": \"<string>\",\n \"is_active\": true,\n \"country\": \"<string>\",\n \"state\": \"<string>\"\n }\n ],\n \"organisations\": [\n {\n \"id\": 123,\n \"role_definition_id\": 123,\n \"expires_at\": \"2023-11-07T05:31:56Z\",\n \"is_active\": true\n }\n ],\n \"attributes\": {\n \"comms\": {\n \"email_consent_updated_at\": \"2023-11-07T05:31:56Z\",\n \"sms_consent_updated_at\": \"2023-11-07T05:31:56Z\"\n },\n \"appearance\": [\n \"<string>\"\n ]\n }\n }\n ],\n \"import_job_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"message": "<string>",
"batch_id": "<string>"
}
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>",
"errors": {}
}Profile
Batch Profiles
A POST to the /profiles/batch.json endpoint allows your application to process profiles in batch.
POST
/
v3
/
profiles
/
batch
Batch Profiles
curl --request POST \
--url https://api.{tenant}.getomneo.com/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>",
"currency": "<string>",
"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>",
"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>"
}
'import requests
url = "https://api.{tenant}.getomneo.com/api/v3/profiles/batch"
payload = {
"match_criteria": "<string>",
"profiles": [
{
"first_name": "<string>",
"last_name": "<string>",
"email": "jsmith@example.com",
"title": "<string>",
"currency": "<string>",
"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>",
"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>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
match_criteria: '<string>',
profiles: [
{
first_name: '<string>',
last_name: '<string>',
email: 'jsmith@example.com',
title: '<string>',
currency: '<string>',
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>', 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>'
})
};
fetch('https://api.{tenant}.getomneo.com/api/v3/profiles/batch', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.{tenant}.getomneo.com/api/v3/profiles/batch",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'match_criteria' => '<string>',
'profiles' => [
[
'first_name' => '<string>',
'last_name' => '<string>',
'email' => 'jsmith@example.com',
'title' => '<string>',
'currency' => '<string>',
'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>',
'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>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.{tenant}.getomneo.com/api/v3/profiles/batch"
payload := strings.NewReader("{\n \"match_criteria\": \"<string>\",\n \"profiles\": [\n {\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"title\": \"<string>\",\n \"currency\": \"<string>\",\n \"joined_at\": \"2023-11-07T05:31:56Z\",\n \"mobile_phone\": \"<string>\",\n \"secondary_phone\": \"<string>\",\n \"birth_day\": 123,\n \"birth_month\": 123,\n \"birth_year\": 123,\n \"company\": \"<string>\",\n \"occupation\": \"<string>\",\n \"avatar_url\": \"<string>\",\n \"joined_location_id\": 123,\n \"joined_location_external_id\": \"<string>\",\n \"joined_location_external_code\": \"<string>\",\n \"preferred_location_id\": 123,\n \"preferred_location_external_id\": \"<string>\",\n \"preferred_location_external_code\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"identities\": [\n {\n \"handle\": \"<string>\",\n \"identifier\": \"<string>\",\n \"is_active\": true\n }\n ],\n \"custom_attributes\": [\n {\n \"namespace\": \"<string>\",\n \"handle\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"dates_attributes\": [\n {\n \"date\": \"2023-12-25\",\n \"name\": \"<string>\",\n \"handle\": \"<string>\",\n \"is_recurring\": true,\n \"recurring_schedule\": \"<string>\",\n \"meta\": [\n \"<string>\"\n ],\n \"note\": \"<string>\",\n \"description\": \"<string>\",\n \"relationship\": \"<string>\",\n \"role\": \"<string>\",\n \"links\": [\n {\n \"profile_id\": \"<string>\",\n \"relationship\": \"<string>\",\n \"role\": \"<string>\"\n }\n ]\n }\n ],\n \"statuses\": [\n \"<string>\"\n ],\n \"addresses\": [\n {\n \"address_line_1\": \"<string>\",\n \"city\": \"<string>\",\n \"postcode\": \"<string>\",\n \"country\": \"<string>\",\n \"address_line_2\": \"<string>\",\n \"address_line_3\": \"<string>\",\n \"company\": \"<string>\",\n \"state\": \"<string>\",\n \"notes\": \"<string>\",\n \"is_default\": true,\n \"external_id\": \"<string>\",\n \"meta\": [\n \"<string>\"\n ],\n \"iso\": \"<string>\",\n \"iso_state\": \"<string>\"\n }\n ],\n \"comms_attributes\": {\n \"sms_promo\": true,\n \"email_promo\": true,\n \"email_bounced\": true,\n \"email_benefits\": true,\n \"email_consent_updated_at\": \"2023-11-07T05:31:56Z\",\n \"sms_consent_updated_at\": \"2023-11-07T05:31:56Z\"\n },\n \"region_id\": 123,\n \"region\": \"<string>\",\n \"region_country\": \"<string>\",\n \"region_state\": \"<string>\",\n \"regions\": [\n {\n \"region_id\": 123,\n \"handle\": \"<string>\",\n \"is_active\": true,\n \"country\": \"<string>\",\n \"state\": \"<string>\"\n }\n ],\n \"organisations\": [\n {\n \"id\": 123,\n \"role_definition_id\": 123,\n \"expires_at\": \"2023-11-07T05:31:56Z\",\n \"is_active\": true\n }\n ],\n \"attributes\": {\n \"comms\": {\n \"email_consent_updated_at\": \"2023-11-07T05:31:56Z\",\n \"sms_consent_updated_at\": \"2023-11-07T05:31:56Z\"\n },\n \"appearance\": [\n \"<string>\"\n ]\n }\n }\n ],\n \"import_job_id\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.{tenant}.getomneo.com/api/v3/profiles/batch")
.header("Content-Type", "application/json")
.body("{\n \"match_criteria\": \"<string>\",\n \"profiles\": [\n {\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"title\": \"<string>\",\n \"currency\": \"<string>\",\n \"joined_at\": \"2023-11-07T05:31:56Z\",\n \"mobile_phone\": \"<string>\",\n \"secondary_phone\": \"<string>\",\n \"birth_day\": 123,\n \"birth_month\": 123,\n \"birth_year\": 123,\n \"company\": \"<string>\",\n \"occupation\": \"<string>\",\n \"avatar_url\": \"<string>\",\n \"joined_location_id\": 123,\n \"joined_location_external_id\": \"<string>\",\n \"joined_location_external_code\": \"<string>\",\n \"preferred_location_id\": 123,\n \"preferred_location_external_id\": \"<string>\",\n \"preferred_location_external_code\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"identities\": [\n {\n \"handle\": \"<string>\",\n \"identifier\": \"<string>\",\n \"is_active\": true\n }\n ],\n \"custom_attributes\": [\n {\n \"namespace\": \"<string>\",\n \"handle\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"dates_attributes\": [\n {\n \"date\": \"2023-12-25\",\n \"name\": \"<string>\",\n \"handle\": \"<string>\",\n \"is_recurring\": true,\n \"recurring_schedule\": \"<string>\",\n \"meta\": [\n \"<string>\"\n ],\n \"note\": \"<string>\",\n \"description\": \"<string>\",\n \"relationship\": \"<string>\",\n \"role\": \"<string>\",\n \"links\": [\n {\n \"profile_id\": \"<string>\",\n \"relationship\": \"<string>\",\n \"role\": \"<string>\"\n }\n ]\n }\n ],\n \"statuses\": [\n \"<string>\"\n ],\n \"addresses\": [\n {\n \"address_line_1\": \"<string>\",\n \"city\": \"<string>\",\n \"postcode\": \"<string>\",\n \"country\": \"<string>\",\n \"address_line_2\": \"<string>\",\n \"address_line_3\": \"<string>\",\n \"company\": \"<string>\",\n \"state\": \"<string>\",\n \"notes\": \"<string>\",\n \"is_default\": true,\n \"external_id\": \"<string>\",\n \"meta\": [\n \"<string>\"\n ],\n \"iso\": \"<string>\",\n \"iso_state\": \"<string>\"\n }\n ],\n \"comms_attributes\": {\n \"sms_promo\": true,\n \"email_promo\": true,\n \"email_bounced\": true,\n \"email_benefits\": true,\n \"email_consent_updated_at\": \"2023-11-07T05:31:56Z\",\n \"sms_consent_updated_at\": \"2023-11-07T05:31:56Z\"\n },\n \"region_id\": 123,\n \"region\": \"<string>\",\n \"region_country\": \"<string>\",\n \"region_state\": \"<string>\",\n \"regions\": [\n {\n \"region_id\": 123,\n \"handle\": \"<string>\",\n \"is_active\": true,\n \"country\": \"<string>\",\n \"state\": \"<string>\"\n }\n ],\n \"organisations\": [\n {\n \"id\": 123,\n \"role_definition_id\": 123,\n \"expires_at\": \"2023-11-07T05:31:56Z\",\n \"is_active\": true\n }\n ],\n \"attributes\": {\n \"comms\": {\n \"email_consent_updated_at\": \"2023-11-07T05:31:56Z\",\n \"sms_consent_updated_at\": \"2023-11-07T05:31:56Z\"\n },\n \"appearance\": [\n \"<string>\"\n ]\n }\n }\n ],\n \"import_job_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.{tenant}.getomneo.com/api/v3/profiles/batch")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"match_criteria\": \"<string>\",\n \"profiles\": [\n {\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"title\": \"<string>\",\n \"currency\": \"<string>\",\n \"joined_at\": \"2023-11-07T05:31:56Z\",\n \"mobile_phone\": \"<string>\",\n \"secondary_phone\": \"<string>\",\n \"birth_day\": 123,\n \"birth_month\": 123,\n \"birth_year\": 123,\n \"company\": \"<string>\",\n \"occupation\": \"<string>\",\n \"avatar_url\": \"<string>\",\n \"joined_location_id\": 123,\n \"joined_location_external_id\": \"<string>\",\n \"joined_location_external_code\": \"<string>\",\n \"preferred_location_id\": 123,\n \"preferred_location_external_id\": \"<string>\",\n \"preferred_location_external_code\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"identities\": [\n {\n \"handle\": \"<string>\",\n \"identifier\": \"<string>\",\n \"is_active\": true\n }\n ],\n \"custom_attributes\": [\n {\n \"namespace\": \"<string>\",\n \"handle\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"dates_attributes\": [\n {\n \"date\": \"2023-12-25\",\n \"name\": \"<string>\",\n \"handle\": \"<string>\",\n \"is_recurring\": true,\n \"recurring_schedule\": \"<string>\",\n \"meta\": [\n \"<string>\"\n ],\n \"note\": \"<string>\",\n \"description\": \"<string>\",\n \"relationship\": \"<string>\",\n \"role\": \"<string>\",\n \"links\": [\n {\n \"profile_id\": \"<string>\",\n \"relationship\": \"<string>\",\n \"role\": \"<string>\"\n }\n ]\n }\n ],\n \"statuses\": [\n \"<string>\"\n ],\n \"addresses\": [\n {\n \"address_line_1\": \"<string>\",\n \"city\": \"<string>\",\n \"postcode\": \"<string>\",\n \"country\": \"<string>\",\n \"address_line_2\": \"<string>\",\n \"address_line_3\": \"<string>\",\n \"company\": \"<string>\",\n \"state\": \"<string>\",\n \"notes\": \"<string>\",\n \"is_default\": true,\n \"external_id\": \"<string>\",\n \"meta\": [\n \"<string>\"\n ],\n \"iso\": \"<string>\",\n \"iso_state\": \"<string>\"\n }\n ],\n \"comms_attributes\": {\n \"sms_promo\": true,\n \"email_promo\": true,\n \"email_bounced\": true,\n \"email_benefits\": true,\n \"email_consent_updated_at\": \"2023-11-07T05:31:56Z\",\n \"sms_consent_updated_at\": \"2023-11-07T05:31:56Z\"\n },\n \"region_id\": 123,\n \"region\": \"<string>\",\n \"region_country\": \"<string>\",\n \"region_state\": \"<string>\",\n \"regions\": [\n {\n \"region_id\": 123,\n \"handle\": \"<string>\",\n \"is_active\": true,\n \"country\": \"<string>\",\n \"state\": \"<string>\"\n }\n ],\n \"organisations\": [\n {\n \"id\": 123,\n \"role_definition_id\": 123,\n \"expires_at\": \"2023-11-07T05:31:56Z\",\n \"is_active\": true\n }\n ],\n \"attributes\": {\n \"comms\": {\n \"email_consent_updated_at\": \"2023-11-07T05:31:56Z\",\n \"sms_consent_updated_at\": \"2023-11-07T05:31:56Z\"\n },\n \"appearance\": [\n \"<string>\"\n ]\n }\n }\n ],\n \"import_job_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"message": "<string>",
"batch_id": "<string>"
}
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>",
"errors": {}
}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 appropriateprofile.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:
{
"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"
}
]
}
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"
}
]
}
]
}
⌘I