Batch Patch Resources

curl --request PATCH \
  --url https://api.embedreach.com/api/resources/{schemaDefinitionNameOrId}/batch \
  --header 'Content-Type: application/json' \
  --data '
{
  "resources": [
    {}
  ]
}
'

import requests

url = "https://api.embedreach.com/api/resources/{schemaDefinitionNameOrId}/batch"

payload = { "resources": [{}] }
headers = {"Content-Type": "application/json"}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({resources: [{}]})
};

fetch('https://api.embedreach.com/api/resources/{schemaDefinitionNameOrId}/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.embedreach.com/api/resources/{schemaDefinitionNameOrId}/batch",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'resources' => [
        [
                
        ]
    ]
  ]),
  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.embedreach.com/api/resources/{schemaDefinitionNameOrId}/batch"

	payload := strings.NewReader("{\n  \"resources\": [\n    {}\n  ]\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.embedreach.com/api/resources/{schemaDefinitionNameOrId}/batch")
  .header("Content-Type", "application/json")
  .body("{\n  \"resources\": [\n    {}\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.embedreach.com/api/resources/{schemaDefinitionNameOrId}/batch")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"resources\": [\n    {}\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "message": "<string>",
  "data": {
    "batchId": "<string>",
    "message": "<string>",
    "recordCount": 123,
    "schemaDefinitionId": "<string>"
  }
}

{
  "message": "<string>",
  "success": false,
  "errors": [
    "<string>"
  ]
}

{
  "success": true,
  "message": "<string>",
  "data": {
    "error": "<string>"
  }
}

Partner Resources

Batch Patch Resources

Patches multiple resources in a single batch via the event processor for asynchronous processing. Fields not included in the request are left unchanged. Null values will explicitly delete the field (required fields cannot be deleted and will return a validation error). The batch ID can be used to retrieve the status of the batch using the /api/batches/:batchId endpoint. The maximum number of resources that can be updated in a single batch is 1000.There are NO ordering guarantees across multiple batches. Within each batch, the patches for each resource are processed in the order they are received.

PATCH

api

resources

{schemaDefinitionNameOrId}

batch

Batch Patch Resources

curl --request PATCH \
  --url https://api.embedreach.com/api/resources/{schemaDefinitionNameOrId}/batch \
  --header 'Content-Type: application/json' \
  --data '
{
  "resources": [
    {}
  ]
}
'

import requests

url = "https://api.embedreach.com/api/resources/{schemaDefinitionNameOrId}/batch"

payload = { "resources": [{}] }
headers = {"Content-Type": "application/json"}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({resources: [{}]})
};

fetch('https://api.embedreach.com/api/resources/{schemaDefinitionNameOrId}/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.embedreach.com/api/resources/{schemaDefinitionNameOrId}/batch",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'resources' => [
        [
                
        ]
    ]
  ]),
  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.embedreach.com/api/resources/{schemaDefinitionNameOrId}/batch"

	payload := strings.NewReader("{\n  \"resources\": [\n    {}\n  ]\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.embedreach.com/api/resources/{schemaDefinitionNameOrId}/batch")
  .header("Content-Type", "application/json")
  .body("{\n  \"resources\": [\n    {}\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.embedreach.com/api/resources/{schemaDefinitionNameOrId}/batch")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"resources\": [\n    {}\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "message": "<string>",
  "data": {
    "batchId": "<string>",
    "message": "<string>",
    "recordCount": 123,
    "schemaDefinitionId": "<string>"
  }
}

{
  "message": "<string>",
  "success": false,
  "errors": [
    "<string>"
  ]
}

{
  "success": true,
  "message": "<string>",
  "data": {
    "error": "<string>"
  }
}

Headers

reach-tenant-id

string

If using a platform scoped JWT, you can pass in a header to impersonate a specific tenant to impersonate the request as.

Path Parameters

schemaDefinitionNameOrId

string

required

The name or id of the schema definition to update the resources in

Query Parameters

ignoreUnknownFields

string | null

default:false

Whether to allow extra fields that are not defined in the schema. If true, extra fields will be accepted but not saved. If false, requests with extra fields will be rejected.

Body

application/json

resources

object[]

required

An array of resources to upload

Show child attributes

Response

Status 202 response

success

boolean

required

message

string

data

object

Show child attributes