Batch Benefits
curl --request POST \
--url https://api.{tenant}.getomneo.com/api/v3/benefits/batch.json \
--header 'Content-Type: application/json' \
--data '
{
"benefits": [
{
"profile_id": "<string>",
"issued_at": "2023-11-07T05:31:56Z",
"timezone": "<string>",
"profile_id_handle": "<string>",
"benefit_definition_id": 123,
"benefit_definition_handle": "<string>",
"external_id": "<string>",
"meta": [
"<string>"
],
"expires_at": "<string>",
"value": 123
}
],
"import_job_id": "<string>"
}
'import requests
url = "https://api.{tenant}.getomneo.com/api/v3/benefits/batch.json"
payload = {
"benefits": [
{
"profile_id": "<string>",
"issued_at": "2023-11-07T05:31:56Z",
"timezone": "<string>",
"profile_id_handle": "<string>",
"benefit_definition_id": 123,
"benefit_definition_handle": "<string>",
"external_id": "<string>",
"meta": ["<string>"],
"expires_at": "<string>",
"value": 123
}
],
"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({
benefits: [
{
profile_id: '<string>',
issued_at: '2023-11-07T05:31:56Z',
timezone: '<string>',
profile_id_handle: '<string>',
benefit_definition_id: 123,
benefit_definition_handle: '<string>',
external_id: '<string>',
meta: ['<string>'],
expires_at: '<string>',
value: 123
}
],
import_job_id: '<string>'
})
};
fetch('https://api.{tenant}.getomneo.com/api/v3/benefits/batch.json', 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/benefits/batch.json",
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([
'benefits' => [
[
'profile_id' => '<string>',
'issued_at' => '2023-11-07T05:31:56Z',
'timezone' => '<string>',
'profile_id_handle' => '<string>',
'benefit_definition_id' => 123,
'benefit_definition_handle' => '<string>',
'external_id' => '<string>',
'meta' => [
'<string>'
],
'expires_at' => '<string>',
'value' => 123
]
],
'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/benefits/batch.json"
payload := strings.NewReader("{\n \"benefits\": [\n {\n \"profile_id\": \"<string>\",\n \"issued_at\": \"2023-11-07T05:31:56Z\",\n \"timezone\": \"<string>\",\n \"profile_id_handle\": \"<string>\",\n \"benefit_definition_id\": 123,\n \"benefit_definition_handle\": \"<string>\",\n \"external_id\": \"<string>\",\n \"meta\": [\n \"<string>\"\n ],\n \"expires_at\": \"<string>\",\n \"value\": 123\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/benefits/batch.json")
.header("Content-Type", "application/json")
.body("{\n \"benefits\": [\n {\n \"profile_id\": \"<string>\",\n \"issued_at\": \"2023-11-07T05:31:56Z\",\n \"timezone\": \"<string>\",\n \"profile_id_handle\": \"<string>\",\n \"benefit_definition_id\": 123,\n \"benefit_definition_handle\": \"<string>\",\n \"external_id\": \"<string>\",\n \"meta\": [\n \"<string>\"\n ],\n \"expires_at\": \"<string>\",\n \"value\": 123\n }\n ],\n \"import_job_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.{tenant}.getomneo.com/api/v3/benefits/batch.json")
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 \"benefits\": [\n {\n \"profile_id\": \"<string>\",\n \"issued_at\": \"2023-11-07T05:31:56Z\",\n \"timezone\": \"<string>\",\n \"profile_id_handle\": \"<string>\",\n \"benefit_definition_id\": 123,\n \"benefit_definition_handle\": \"<string>\",\n \"external_id\": \"<string>\",\n \"meta\": [\n \"<string>\"\n ],\n \"expires_at\": \"<string>\",\n \"value\": 123\n }\n ],\n \"import_job_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"message": "<string>",
"batch_id": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>",
"errors": {}
}Benefit
Batch Benefits
A POST to the /benefits/batch.json endpoint allows your application to process benefits in batch.
POST
/
v3
/
benefits
/
batch.json
Batch Benefits
curl --request POST \
--url https://api.{tenant}.getomneo.com/api/v3/benefits/batch.json \
--header 'Content-Type: application/json' \
--data '
{
"benefits": [
{
"profile_id": "<string>",
"issued_at": "2023-11-07T05:31:56Z",
"timezone": "<string>",
"profile_id_handle": "<string>",
"benefit_definition_id": 123,
"benefit_definition_handle": "<string>",
"external_id": "<string>",
"meta": [
"<string>"
],
"expires_at": "<string>",
"value": 123
}
],
"import_job_id": "<string>"
}
'import requests
url = "https://api.{tenant}.getomneo.com/api/v3/benefits/batch.json"
payload = {
"benefits": [
{
"profile_id": "<string>",
"issued_at": "2023-11-07T05:31:56Z",
"timezone": "<string>",
"profile_id_handle": "<string>",
"benefit_definition_id": 123,
"benefit_definition_handle": "<string>",
"external_id": "<string>",
"meta": ["<string>"],
"expires_at": "<string>",
"value": 123
}
],
"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({
benefits: [
{
profile_id: '<string>',
issued_at: '2023-11-07T05:31:56Z',
timezone: '<string>',
profile_id_handle: '<string>',
benefit_definition_id: 123,
benefit_definition_handle: '<string>',
external_id: '<string>',
meta: ['<string>'],
expires_at: '<string>',
value: 123
}
],
import_job_id: '<string>'
})
};
fetch('https://api.{tenant}.getomneo.com/api/v3/benefits/batch.json', 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/benefits/batch.json",
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([
'benefits' => [
[
'profile_id' => '<string>',
'issued_at' => '2023-11-07T05:31:56Z',
'timezone' => '<string>',
'profile_id_handle' => '<string>',
'benefit_definition_id' => 123,
'benefit_definition_handle' => '<string>',
'external_id' => '<string>',
'meta' => [
'<string>'
],
'expires_at' => '<string>',
'value' => 123
]
],
'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/benefits/batch.json"
payload := strings.NewReader("{\n \"benefits\": [\n {\n \"profile_id\": \"<string>\",\n \"issued_at\": \"2023-11-07T05:31:56Z\",\n \"timezone\": \"<string>\",\n \"profile_id_handle\": \"<string>\",\n \"benefit_definition_id\": 123,\n \"benefit_definition_handle\": \"<string>\",\n \"external_id\": \"<string>\",\n \"meta\": [\n \"<string>\"\n ],\n \"expires_at\": \"<string>\",\n \"value\": 123\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/benefits/batch.json")
.header("Content-Type", "application/json")
.body("{\n \"benefits\": [\n {\n \"profile_id\": \"<string>\",\n \"issued_at\": \"2023-11-07T05:31:56Z\",\n \"timezone\": \"<string>\",\n \"profile_id_handle\": \"<string>\",\n \"benefit_definition_id\": 123,\n \"benefit_definition_handle\": \"<string>\",\n \"external_id\": \"<string>\",\n \"meta\": [\n \"<string>\"\n ],\n \"expires_at\": \"<string>\",\n \"value\": 123\n }\n ],\n \"import_job_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.{tenant}.getomneo.com/api/v3/benefits/batch.json")
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 \"benefits\": [\n {\n \"profile_id\": \"<string>\",\n \"issued_at\": \"2023-11-07T05:31:56Z\",\n \"timezone\": \"<string>\",\n \"profile_id_handle\": \"<string>\",\n \"benefit_definition_id\": 123,\n \"benefit_definition_handle\": \"<string>\",\n \"external_id\": \"<string>\",\n \"meta\": [\n \"<string>\"\n ],\n \"expires_at\": \"<string>\",\n \"value\": 123\n }\n ],\n \"import_job_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"message": "<string>",
"batch_id": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>",
"errors": {}
}⌘I