Batch Patch Customer Resources

Patches multiple customer resources in a single batch via the event processor for asynchronous processing.

PATCH /api/resources/customers/batch

Batch Patch Customer Resources

cURL

curl --request PATCH \
  --url https://api.embedreach.com/api/resources/customers/batch \
  --header 'Content-Type: application/json' \
  --data '
{
  "resources": [
    {
      "customerId": "<string>",
      "email": "<string>",
      "phone": "<string>",
      "firstName": "<string>",
      "lastName": "<string>",
      "emailOptOut": true,
      "smsOptOut": true,
      "customerDetailUrl": "<string>",
      "createdAt": "2023-11-07T05:31:56Z"
    }
  ]
}
'

import requests

url = "https://api.embedreach.com/api/resources/customers/batch"

payload = { "resources": [
        {
            "customerId": "<string>",
            "email": "<string>",
            "phone": "<string>",
            "firstName": "<string>",
            "lastName": "<string>",
            "emailOptOut": True,
            "smsOptOut": True,
            "customerDetailUrl": "<string>",
            "createdAt": "2023-11-07T05:31:56Z"
        }
    ] }
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: [
      {
        customerId: '<string>',
        email: '<string>',
        phone: '<string>',
        firstName: '<string>',
        lastName: '<string>',
        emailOptOut: true,
        smsOptOut: true,
        customerDetailUrl: '<string>',
        createdAt: '2023-11-07T05:31:56Z'
      }
    ]
  })
};

fetch('https://api.embedreach.com/api/resources/customers/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/customers/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' => [
        [
                'customerId' => '<string>',
                'email' => '<string>',
                'phone' => '<string>',
                'firstName' => '<string>',
                'lastName' => '<string>',
                'emailOptOut' => true,
                'smsOptOut' => true,
                'customerDetailUrl' => '<string>',
                'createdAt' => '2023-11-07T05:31:56Z'
        ]
    ]
  ]),
  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/customers/batch"

	payload := strings.NewReader("{\n  \"resources\": [\n    {\n      \"customerId\": \"<string>\",\n      \"email\": \"<string>\",\n      \"phone\": \"<string>\",\n      \"firstName\": \"<string>\",\n      \"lastName\": \"<string>\",\n      \"emailOptOut\": true,\n      \"smsOptOut\": true,\n      \"customerDetailUrl\": \"<string>\",\n      \"createdAt\": \"2023-11-07T05:31:56Z\"\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/customers/batch")
  .header("Content-Type", "application/json")
  .body("{\n  \"resources\": [\n    {\n      \"customerId\": \"<string>\",\n      \"email\": \"<string>\",\n      \"phone\": \"<string>\",\n      \"firstName\": \"<string>\",\n      \"lastName\": \"<string>\",\n      \"emailOptOut\": true,\n      \"smsOptOut\": true,\n      \"customerDetailUrl\": \"<string>\",\n      \"createdAt\": \"2023-11-07T05:31:56Z\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.embedreach.com/api/resources/customers/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      \"customerId\": \"<string>\",\n      \"email\": \"<string>\",\n      \"phone\": \"<string>\",\n      \"firstName\": \"<string>\",\n      \"lastName\": \"<string>\",\n      \"emailOptOut\": true,\n      \"smsOptOut\": true,\n      \"customerDetailUrl\": \"<string>\",\n      \"createdAt\": \"2023-11-07T05:31:56Z\"\n    }\n  ]\n}"

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

202

{
  "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.

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 partial customer resources to patch

Show child attributes

Response

202

application/json

Status 202 response

success · boolean · required

message · string

data · object

Show child attributes