Update Partner Schema Mappings

Update partner schema mappings (Used to map important fields from partner resources to Reach Functions)

POST /partner/schema-mappings

Update Partner Schema Mappings

cURL

curl --request POST \
  --url https://api.embedreach.com/partner/schema-mappings \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "combined_schema",
  "transactionsSchema": [
    {
      "type": "transactions_schema",
      "eventType": "<string>",
      "schemaId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "id_field": "<string>",
      "userId": "<string>",
      "amount": {
        "field": "<string>",
        "currencyField": "<string>"
      },
      "dates": {
        "createdDate": "<string>",
        "paidDate": "<string>",
        "dueDate": "<string>",
        "startDate": "<string>",
        "endDate": "<string>"
      },
      "locationId": "<string>",
      "metadata": [
        "<string>"
      ],
      "filter": true,
      "urlPattern": "<string>"
    }
  ],
  "customSchema": [
    {
      "type": "custom_schema",
      "id_field": "<string>",
      "date": "<string>",
      "userId": "<string>",
      "schemaId": "<string>",
      "metadata": [
        "<string>"
      ]
    }
  ],
  "locationsSchema": [
    {
      "type": "locations_schema",
      "schemaId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "id_field": "<string>",
      "name": "<string>",
      "address_line_1": "<string>",
      "address_line_2": "<string>",
      "address_line_3": "<string>",
      "locality": "<string>",
      "district": "<string>",
      "postal_code": "<string>",
      "country_code": "<string>",
      "phone": "<string>",
      "email": "<string>",
      "website": "<string>",
      "urlPattern": "<string>"
    }
  ]
}
'

import requests

url = "https://api.embedreach.com/partner/schema-mappings"

payload = {
    "type": "combined_schema",
    "transactionsSchema": [
        {
            "type": "transactions_schema",
            "eventType": "<string>",
            "schemaId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "id_field": "<string>",
            "userId": "<string>",
            "amount": {
                "field": "<string>",
                "currencyField": "<string>"
            },
            "dates": {
                "createdDate": "<string>",
                "paidDate": "<string>",
                "dueDate": "<string>",
                "startDate": "<string>",
                "endDate": "<string>"
            },
            "locationId": "<string>",
            "metadata": ["<string>"],
            "filter": True,
            "urlPattern": "<string>"
        }
    ],
    "customSchema": [
        {
            "type": "custom_schema",
            "id_field": "<string>",
            "date": "<string>",
            "userId": "<string>",
            "schemaId": "<string>",
            "metadata": ["<string>"]
        }
    ],
    "locationsSchema": [
        {
            "type": "locations_schema",
            "schemaId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "id_field": "<string>",
            "name": "<string>",
            "address_line_1": "<string>",
            "address_line_2": "<string>",
            "address_line_3": "<string>",
            "locality": "<string>",
            "district": "<string>",
            "postal_code": "<string>",
            "country_code": "<string>",
            "phone": "<string>",
            "email": "<string>",
            "website": "<string>",
            "urlPattern": "<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({
    type: 'combined_schema',
    transactionsSchema: [
      {
        type: 'transactions_schema',
        eventType: '<string>',
        schemaId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        id_field: '<string>',
        userId: '<string>',
        amount: {field: '<string>', currencyField: '<string>'},
        dates: {
          createdDate: '<string>',
          paidDate: '<string>',
          dueDate: '<string>',
          startDate: '<string>',
          endDate: '<string>'
        },
        locationId: '<string>',
        metadata: ['<string>'],
        filter: true,
        urlPattern: '<string>'
      }
    ],
    customSchema: [
      {
        type: 'custom_schema',
        id_field: '<string>',
        date: '<string>',
        userId: '<string>',
        schemaId: '<string>',
        metadata: ['<string>']
      }
    ],
    locationsSchema: [
      {
        type: 'locations_schema',
        schemaId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        id_field: '<string>',
        name: '<string>',
        address_line_1: '<string>',
        address_line_2: '<string>',
        address_line_3: '<string>',
        locality: '<string>',
        district: '<string>',
        postal_code: '<string>',
        country_code: '<string>',
        phone: '<string>',
        email: '<string>',
        website: '<string>',
        urlPattern: '<string>'
      }
    ]
  })
};

fetch('https://api.embedreach.com/partner/schema-mappings', 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/partner/schema-mappings",
  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([
    'type' => 'combined_schema',
    'transactionsSchema' => [
        [
                'type' => 'transactions_schema',
                'eventType' => '<string>',
                'schemaId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                'id_field' => '<string>',
                'userId' => '<string>',
                'amount' => [
                                'field' => '<string>',
                                'currencyField' => '<string>'
                ],
                'dates' => [
                                'createdDate' => '<string>',
                                'paidDate' => '<string>',
                                'dueDate' => '<string>',
                                'startDate' => '<string>',
                                'endDate' => '<string>'
                ],
                'locationId' => '<string>',
                'metadata' => [
                                '<string>'
                ],
                'filter' => true,
                'urlPattern' => '<string>'
        ]
    ],
    'customSchema' => [
        [
                'type' => 'custom_schema',
                'id_field' => '<string>',
                'date' => '<string>',
                'userId' => '<string>',
                'schemaId' => '<string>',
                'metadata' => [
                                '<string>'
                ]
        ]
    ],
    'locationsSchema' => [
        [
                'type' => 'locations_schema',
                'schemaId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                'id_field' => '<string>',
                'name' => '<string>',
                'address_line_1' => '<string>',
                'address_line_2' => '<string>',
                'address_line_3' => '<string>',
                'locality' => '<string>',
                'district' => '<string>',
                'postal_code' => '<string>',
                'country_code' => '<string>',
                'phone' => '<string>',
                'email' => '<string>',
                'website' => '<string>',
                'urlPattern' => '<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.embedreach.com/partner/schema-mappings"

	payload := strings.NewReader("{\n  \"type\": \"combined_schema\",\n  \"transactionsSchema\": [\n    {\n      \"type\": \"transactions_schema\",\n      \"eventType\": \"<string>\",\n      \"schemaId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"id_field\": \"<string>\",\n      \"userId\": \"<string>\",\n      \"amount\": {\n        \"field\": \"<string>\",\n        \"currencyField\": \"<string>\"\n      },\n      \"dates\": {\n        \"createdDate\": \"<string>\",\n        \"paidDate\": \"<string>\",\n        \"dueDate\": \"<string>\",\n        \"startDate\": \"<string>\",\n        \"endDate\": \"<string>\"\n      },\n      \"locationId\": \"<string>\",\n      \"metadata\": [\n        \"<string>\"\n      ],\n      \"filter\": true,\n      \"urlPattern\": \"<string>\"\n    }\n  ],\n  \"customSchema\": [\n    {\n      \"type\": \"custom_schema\",\n      \"id_field\": \"<string>\",\n      \"date\": \"<string>\",\n      \"userId\": \"<string>\",\n      \"schemaId\": \"<string>\",\n      \"metadata\": [\n        \"<string>\"\n      ]\n    }\n  ],\n  \"locationsSchema\": [\n    {\n      \"type\": \"locations_schema\",\n      \"schemaId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"id_field\": \"<string>\",\n      \"name\": \"<string>\",\n      \"address_line_1\": \"<string>\",\n      \"address_line_2\": \"<string>\",\n      \"address_line_3\": \"<string>\",\n      \"locality\": \"<string>\",\n      \"district\": \"<string>\",\n      \"postal_code\": \"<string>\",\n      \"country_code\": \"<string>\",\n      \"phone\": \"<string>\",\n      \"email\": \"<string>\",\n      \"website\": \"<string>\",\n      \"urlPattern\": \"<string>\"\n    }\n  ]\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.embedreach.com/partner/schema-mappings")
  .header("Content-Type", "application/json")
  .body("{\n  \"type\": \"combined_schema\",\n  \"transactionsSchema\": [\n    {\n      \"type\": \"transactions_schema\",\n      \"eventType\": \"<string>\",\n      \"schemaId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"id_field\": \"<string>\",\n      \"userId\": \"<string>\",\n      \"amount\": {\n        \"field\": \"<string>\",\n        \"currencyField\": \"<string>\"\n      },\n      \"dates\": {\n        \"createdDate\": \"<string>\",\n        \"paidDate\": \"<string>\",\n        \"dueDate\": \"<string>\",\n        \"startDate\": \"<string>\",\n        \"endDate\": \"<string>\"\n      },\n      \"locationId\": \"<string>\",\n      \"metadata\": [\n        \"<string>\"\n      ],\n      \"filter\": true,\n      \"urlPattern\": \"<string>\"\n    }\n  ],\n  \"customSchema\": [\n    {\n      \"type\": \"custom_schema\",\n      \"id_field\": \"<string>\",\n      \"date\": \"<string>\",\n      \"userId\": \"<string>\",\n      \"schemaId\": \"<string>\",\n      \"metadata\": [\n        \"<string>\"\n      ]\n    }\n  ],\n  \"locationsSchema\": [\n    {\n      \"type\": \"locations_schema\",\n      \"schemaId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"id_field\": \"<string>\",\n      \"name\": \"<string>\",\n      \"address_line_1\": \"<string>\",\n      \"address_line_2\": \"<string>\",\n      \"address_line_3\": \"<string>\",\n      \"locality\": \"<string>\",\n      \"district\": \"<string>\",\n      \"postal_code\": \"<string>\",\n      \"country_code\": \"<string>\",\n      \"phone\": \"<string>\",\n      \"email\": \"<string>\",\n      \"website\": \"<string>\",\n      \"urlPattern\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.embedreach.com/partner/schema-mappings")

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  \"type\": \"combined_schema\",\n  \"transactionsSchema\": [\n    {\n      \"type\": \"transactions_schema\",\n      \"eventType\": \"<string>\",\n      \"schemaId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"id_field\": \"<string>\",\n      \"userId\": \"<string>\",\n      \"amount\": {\n        \"field\": \"<string>\",\n        \"currencyField\": \"<string>\"\n      },\n      \"dates\": {\n        \"createdDate\": \"<string>\",\n        \"paidDate\": \"<string>\",\n        \"dueDate\": \"<string>\",\n        \"startDate\": \"<string>\",\n        \"endDate\": \"<string>\"\n      },\n      \"locationId\": \"<string>\",\n      \"metadata\": [\n        \"<string>\"\n      ],\n      \"filter\": true,\n      \"urlPattern\": \"<string>\"\n    }\n  ],\n  \"customSchema\": [\n    {\n      \"type\": \"custom_schema\",\n      \"id_field\": \"<string>\",\n      \"date\": \"<string>\",\n      \"userId\": \"<string>\",\n      \"schemaId\": \"<string>\",\n      \"metadata\": [\n        \"<string>\"\n      ]\n    }\n  ],\n  \"locationsSchema\": [\n    {\n      \"type\": \"locations_schema\",\n      \"schemaId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"id_field\": \"<string>\",\n      \"name\": \"<string>\",\n      \"address_line_1\": \"<string>\",\n      \"address_line_2\": \"<string>\",\n      \"address_line_3\": \"<string>\",\n      \"locality\": \"<string>\",\n      \"district\": \"<string>\",\n      \"postal_code\": \"<string>\",\n      \"country_code\": \"<string>\",\n      \"phone\": \"<string>\",\n      \"email\": \"<string>\",\n      \"website\": \"<string>\",\n      \"urlPattern\": \"<string>\"\n    }\n  ]\n}"

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

200

{
  "success": true,
  "message": "<string>",
  "data": {
    "type": "combined_schema",
    "contactsSchema": {
      "primarySource": {
        "type": "contacts_schema",
        "schemaId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "userId": "<string>",
        "email": "<string>",
        "phone": "<string>",
        "firstName": "<string>",
        "lastName": "<string>",
        "fullName": "<string>",
        "location": "<string>",
        "status": {
          "field": "<string>",
          "activeValue": "<string>",
          "deactivatedValue": "<string>"
        },
        "createdDate": "<string>",
        "emailOptOut": "<string>",
        "emailOptIn": "<string>",
        "emailOptOutTimestamp": "<string>",
        "smsOptOut": "<string>",
        "smsOptIn": "<string>",
        "urlPattern": "<string>",
        "smsOptOutTimestamp": "<string>",
        "pointOfContactName": "<string>",
        "pointOfContactEmail": "<string>",
        "senderProfiles": [
          {
            "profileId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "label": "<string>",
            "nameFieldPath": "<string>",
            "emailFieldPath": "<string>"
          }
        ],
        "hipaaConsent": "<string>"
      },
      "additionalSources": [
        {
          "type": "contacts_schema",
          "schemaId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "userId": "<string>",
          "email": "<string>",
          "phone": "<string>",
          "firstName": "<string>",
          "lastName": "<string>",
          "fullName": "<string>",
          "location": "<string>",
          "status": {
            "field": "<string>",
            "activeValue": "<string>",
            "deactivatedValue": "<string>"
          },
          "createdDate": "<string>",
          "emailOptOut": "<string>",
          "emailOptIn": "<string>",
          "emailOptOutTimestamp": "<string>",
          "smsOptOut": "<string>",
          "smsOptIn": "<string>",
          "urlPattern": "<string>",
          "smsOptOutTimestamp": "<string>",
          "pointOfContactName": "<string>",
          "pointOfContactEmail": "<string>",
          "senderProfiles": [
            {
              "profileId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "label": "<string>",
              "nameFieldPath": "<string>",
              "emailFieldPath": "<string>"
            }
          ],
          "hipaaConsent": "<string>"
        }
      ]
    },
    "transactionsSchema": [
      {
        "type": "transactions_schema",
        "eventType": "<string>",
        "schemaId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "id_field": "<string>",
        "userId": "<string>",
        "amount": {
          "field": "<string>",
          "currencyField": "<string>"
        },
        "dates": {
          "createdDate": "<string>",
          "paidDate": "<string>",
          "dueDate": "<string>",
          "startDate": "<string>",
          "endDate": "<string>"
        },
        "locationId": "<string>",
        "metadata": [
          "<string>"
        ],
        "filter": true,
        "urlPattern": "<string>"
      }
    ],
    "customSchema": [
      {
        "type": "custom_schema",
        "id_field": "<string>",
        "date": "<string>",
        "userId": "<string>",
        "schemaId": "<string>",
        "metadata": [
          "<string>"
        ]
      }
    ],
    "locationsSchema": [
      {
        "type": "locations_schema",
        "schemaId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "id_field": "<string>",
        "name": "<string>",
        "address_line_1": "<string>",
        "address_line_2": "<string>",
        "address_line_3": "<string>",
        "locality": "<string>",
        "district": "<string>",
        "postal_code": "<string>",
        "country_code": "<string>",
        "phone": "<string>",
        "email": "<string>",
        "website": "<string>",
        "urlPattern": "<string>"
      }
    ]
  }
}

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

Body

application/json

type · enum<string> · required

Available options: combined_schema

contactsSchema · object

Show child attributes

transactionsSchema · object[]

Show child attributes

customSchema · object[]

Show child attributes

locationsSchema · object[]

Show child attributes

Response

200

application/json

Status 200 response

success · boolean · required

message · string

data · object

Show child attributes