Get Partner Schema Mappings

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

GET /partner/schema-mappings

Get Partner Schema Mappings

cURL

curl --request GET \
  --url https://api.embedreach.com/partner/schema-mappings

import requests

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

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

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 => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.embedreach.com/partner/schema-mappings")
  .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::Get.new(url)

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>"
  ]
}

Response

200

application/json

Status 200 response

success · boolean · required

message · string

data · object

Show child attributes