Get Partner Schema Mappings - Reach Marketing & Automation Documentation

Get Partner Schema Mappings

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

{
  "success": true,
  "message": "<string>",
  "data": {
    "type": "combined_schema",
    "contactsSchema": {
      "primarySource": {
        "type": "contacts_schema",
        "schemaId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "userId": "<string>",
        "createdDate": "<string>",
        "email": "<string>",
        "phone": "<string>",
        "firstName": "<string>",
        "lastName": "<string>",
        "fullName": "<string>",
        "location": "<string>",
        "status": {
          "field": "<string>",
          "activeValue": "<string>",
          "deactivatedValue": "<string>"
        },
        "emailOptOut": "<string>",
        "emailOptIn": "<string>",
        "emailOptOutTimestamp": "<string>",
        "smsOptOut": "<string>",
        "smsOptIn": "<string>",
        "urlPattern": "<string>",
        "smsOptOutTimestamp": "<string>"
      },
      "additionalSources": [
        {
          "type": "contacts_schema",
          "schemaId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "userId": "<string>",
          "createdDate": "<string>",
          "email": "<string>",
          "phone": "<string>",
          "firstName": "<string>",
          "lastName": "<string>",
          "fullName": "<string>",
          "location": "<string>",
          "status": {
            "field": "<string>",
            "activeValue": "<string>",
            "deactivatedValue": "<string>"
          },
          "emailOptOut": "<string>",
          "emailOptIn": "<string>",
          "emailOptOutTimestamp": "<string>",
          "smsOptOut": "<string>",
          "smsOptIn": "<string>",
          "urlPattern": "<string>",
          "smsOptOutTimestamp": "<string>"
        }
      ]
    },
    "transactionsSchema": [
      {
        "type": "transactions_schema",
        "eventType": "<string>",
        "schemaId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "id_field": "<string>",
        "userId": "<string>",
        "amount": {
          "field": "<string>",
          "currencyField": "<string>",
          "currency": "USD"
        },
        "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>"
      }
    ]
  }
}

GET

partner

schema-mappings

Get Partner Schema Mappings

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

{
  "success": true,
  "message": "<string>",
  "data": {
    "type": "combined_schema",
    "contactsSchema": {
      "primarySource": {
        "type": "contacts_schema",
        "schemaId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "userId": "<string>",
        "createdDate": "<string>",
        "email": "<string>",
        "phone": "<string>",
        "firstName": "<string>",
        "lastName": "<string>",
        "fullName": "<string>",
        "location": "<string>",
        "status": {
          "field": "<string>",
          "activeValue": "<string>",
          "deactivatedValue": "<string>"
        },
        "emailOptOut": "<string>",
        "emailOptIn": "<string>",
        "emailOptOutTimestamp": "<string>",
        "smsOptOut": "<string>",
        "smsOptIn": "<string>",
        "urlPattern": "<string>",
        "smsOptOutTimestamp": "<string>"
      },
      "additionalSources": [
        {
          "type": "contacts_schema",
          "schemaId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "userId": "<string>",
          "createdDate": "<string>",
          "email": "<string>",
          "phone": "<string>",
          "firstName": "<string>",
          "lastName": "<string>",
          "fullName": "<string>",
          "location": "<string>",
          "status": {
            "field": "<string>",
            "activeValue": "<string>",
            "deactivatedValue": "<string>"
          },
          "emailOptOut": "<string>",
          "emailOptIn": "<string>",
          "emailOptOutTimestamp": "<string>",
          "smsOptOut": "<string>",
          "smsOptIn": "<string>",
          "urlPattern": "<string>",
          "smsOptOutTimestamp": "<string>"
        }
      ]
    },
    "transactionsSchema": [
      {
        "type": "transactions_schema",
        "eventType": "<string>",
        "schemaId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "id_field": "<string>",
        "userId": "<string>",
        "amount": {
          "field": "<string>",
          "currencyField": "<string>",
          "currency": "USD"
        },
        "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>"
      }
    ]
  }
}

Response

Status 200 response

success

boolean

required

message

string

data

object

Show child attributes

data.type

enum<string>

required

Available options:

combined_schema

data.contactsSchema

object

Show child attributes

data.contactsSchema.primarySource

object

required

Show child attributes

data.contactsSchema.primarySource.type

enum<string>

required

Available options:

contacts_schema

data.contactsSchema.primarySource.schemaId

string<uuid>

required

data.contactsSchema.primarySource.userId

string

required

Minimum string length: 1

data.contactsSchema.primarySource.createdDate

string

required

Minimum string length: 1

data.contactsSchema.primarySource.email

string

data.contactsSchema.primarySource.phone

string

data.contactsSchema.primarySource.firstName

string

data.contactsSchema.primarySource.lastName

string

data.contactsSchema.primarySource.fullName

string

data.contactsSchema.primarySource.location

string

data.contactsSchema.primarySource.status

object

Show child attributes

data.contactsSchema.primarySource.status.field

string

required

data.contactsSchema.primarySource.status.activeValue

string

required

data.contactsSchema.primarySource.status.deactivatedValue

string

required

data.contactsSchema.primarySource.emailOptOut

string

data.contactsSchema.primarySource.emailOptIn

string

data.contactsSchema.primarySource.emailOptOutTimestamp

string

data.contactsSchema.primarySource.smsOptOut

string

data.contactsSchema.primarySource.smsOptIn

string

data.contactsSchema.primarySource.urlPattern

string

data.contactsSchema.primarySource.smsOptOutTimestamp

string

data.contactsSchema.additionalSources

object[]

Show child attributes

data.contactsSchema.additionalSources.type

enum<string>

required

Available options:

contacts_schema

data.contactsSchema.additionalSources.schemaId

string<uuid>

required

data.contactsSchema.additionalSources.userId

string

required

Minimum string length: 1

data.contactsSchema.additionalSources.createdDate

string

required

Minimum string length: 1

data.contactsSchema.additionalSources.email

string

data.contactsSchema.additionalSources.phone

string

data.contactsSchema.additionalSources.firstName

string

data.contactsSchema.additionalSources.lastName

string

data.contactsSchema.additionalSources.fullName

string

data.contactsSchema.additionalSources.location

string

data.contactsSchema.additionalSources.status

object

Show child attributes

data.contactsSchema.additionalSources.status.field

string

required

data.contactsSchema.additionalSources.status.activeValue

string

required

data.contactsSchema.additionalSources.status.deactivatedValue

string

required

data.contactsSchema.additionalSources.emailOptOut

string

data.contactsSchema.additionalSources.emailOptIn

string

data.contactsSchema.additionalSources.emailOptOutTimestamp

string

data.contactsSchema.additionalSources.smsOptOut

string

data.contactsSchema.additionalSources.smsOptIn

string

data.contactsSchema.additionalSources.urlPattern

string

data.contactsSchema.additionalSources.smsOptOutTimestamp

string

data.transactionsSchema

object[]

Show child attributes

data.transactionsSchema.type

enum<string>

required

Available options:

transactions_schema

data.transactionsSchema.eventType

string

required

data.transactionsSchema.schemaId

string<uuid>

required

data.transactionsSchema.id_field

string

required

Minimum string length: 1

data.transactionsSchema.userId

string

required

Minimum string length: 1

data.transactionsSchema.amount

object

required

Show child attributes

data.transactionsSchema.amount.field

string

required

Minimum string length: 1

data.transactionsSchema.amount.currencyField

string

data.transactionsSchema.amount.currency

enum<string>

Available options:

USD,

CAD,

EUR,

AED,

AFN,

ALL,

AMD,

ARS,

AUD,

AZN,

BAM,

BDT,

BGN,

BHD,

BIF,

BND,

BOB,

BRL,

BWP,

BYN,

BZD,

CDF,

CHF,

CLP,

CNY,

COP,

CRC,

CVE,

CZK,

DJF,

DKK,

DOP,

DZD,

EEK,

EGP,

ERN,

ETB,

GBP,

GEL,

GHS,

GNF,

GTQ,

HKD,

HNL,

HRK,

HUF,

IDR,

ILS,

INR,

IQD,

IRR,

ISK,

JMD,

JOD,

JPY,

KES,

KHR,

KMF,

KRW,

KWD,

KZT,

LBP,

LKR,

LTL,

LVL,

LYD,

MAD,

MDL,

MGA,

MKD,

MMK,

MOP,

MUR,

MXN,

MYR,

MZN,

NAD,

NGN,

NIO,

NOK,

NPR,

NZD,

OMR,

PAB,

PEN,

PHP,

PKR,

PLN,

PYG,

QAR,

RON,

RSD,

RUB,

RWF,

SAR,

SDG,

SEK,

SGD,

SOS,

SYP,

THB,

TND,

TOP,

TRY,

TTD,

TWD,

TZS,

UAH,

UGX,

UYU,

UZS,

VEF,

VND,

XAF,

XOF,

YER,

ZAR,

ZMK,

ZWL

data.transactionsSchema.dates

object

required

Show child attributes

data.transactionsSchema.dates.createdDate

string

data.transactionsSchema.dates.paidDate

string

data.transactionsSchema.dates.dueDate

string

data.transactionsSchema.dates.startDate

string

data.transactionsSchema.dates.endDate

string

data.transactionsSchema.locationId

string

Location ID field

data.transactionsSchema.metadata

string[]

data.transactionsSchema.filter

JSONLogic rule to conditionally create billable events from resources. See: https://jsonlogic.com/

data.transactionsSchema.urlPattern

string

data.customSchema

object[]

Show child attributes

data.customSchema.type

enum<string>

required

Available options:

custom_schema

data.customSchema.id_field

string

required

Minimum string length: 1

data.customSchema.date

string

required

Minimum string length: 1

data.customSchema.userId

string

required

Minimum string length: 1

data.customSchema.schemaId

string

required

Minimum string length: 1

data.customSchema.metadata

string[]

data.locationsSchema

object[]

Show child attributes

data.locationsSchema.type

enum<string>

required

Available options:

locations_schema

data.locationsSchema.schemaId

string<uuid>

required

data.locationsSchema.id_field

string

required

Minimum string length: 1

data.locationsSchema.name

string

data.locationsSchema.address_line_1

string

data.locationsSchema.address_line_2

string

data.locationsSchema.address_line_3

string

data.locationsSchema.locality

string

data.locationsSchema.district

string

data.locationsSchema.postal_code

string

data.locationsSchema.country_code

string

data.locationsSchema.phone

string

data.locationsSchema.email

string

data.locationsSchema.website

string

data.locationsSchema.urlPattern

string

Update Schema Update Partner Schema Mappings

⌘I

API Documentation

Response