curl --request POST \
--url http://localhost/api/v3/profiles/batch.json \
--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>"
]
}
}
]
}
'{
"data": {
"message": "<string>",
"batch_id": "<string>"
}
}A POST to the /profiles/batch.json endpoint allows your application to process profiles in batch.
curl --request POST \
--url http://localhost/api/v3/profiles/batch.json \
--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>"
]
}
}
]
}
'{
"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.