Body
application/json
curl --request POST \
--url https://api.embedreach.com/partner/schema-mappings \
--header 'Content-Type: application/json' \
--data '{
"type": "combined_schema",
"contactsSchema": {
"primarySource": {
"type": "contacts_schema",
"schemaId": "<string>",
"email": "<string>",
"phone": "<string>",
"userId": "<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>"
},
"additionalSources": [
{
"type": "contacts_schema",
"schemaId": "<string>",
"email": "<string>",
"phone": "<string>",
"userId": "<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>"
}
]
},
"transactionsSchema": [
{
"type": "transactions_schema",
"eventType": "<string>",
"schemaId": "<string>",
"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>",
"metadata": [
"<string>"
],
"schemaId": "<string>"
}
],
"locationsSchema": [
{
"type": "locations_schema",
"schemaId": "<string>",
"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>"
}
]
}'{
"success": true,
"message": "<string>",
"data": {
"type": "combined_schema",
"contactsSchema": {
"primarySource": {
"type": "contacts_schema",
"schemaId": "<string>",
"email": "<string>",
"phone": "<string>",
"userId": "<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>"
},
"additionalSources": [
{
"type": "contacts_schema",
"schemaId": "<string>",
"email": "<string>",
"phone": "<string>",
"userId": "<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>"
}
]
},
"transactionsSchema": [
{
"type": "transactions_schema",
"eventType": "<string>",
"schemaId": "<string>",
"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>",
"metadata": [
"<string>"
],
"schemaId": "<string>"
}
],
"locationsSchema": [
{
"type": "locations_schema",
"schemaId": "<string>",
"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>"
}
]
}
}Update partner schema mappings (Used to map important fields from partner resources to Reach Functions)
curl --request POST \
--url https://api.embedreach.com/partner/schema-mappings \
--header 'Content-Type: application/json' \
--data '{
"type": "combined_schema",
"contactsSchema": {
"primarySource": {
"type": "contacts_schema",
"schemaId": "<string>",
"email": "<string>",
"phone": "<string>",
"userId": "<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>"
},
"additionalSources": [
{
"type": "contacts_schema",
"schemaId": "<string>",
"email": "<string>",
"phone": "<string>",
"userId": "<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>"
}
]
},
"transactionsSchema": [
{
"type": "transactions_schema",
"eventType": "<string>",
"schemaId": "<string>",
"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>",
"metadata": [
"<string>"
],
"schemaId": "<string>"
}
],
"locationsSchema": [
{
"type": "locations_schema",
"schemaId": "<string>",
"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>"
}
]
}'{
"success": true,
"message": "<string>",
"data": {
"type": "combined_schema",
"contactsSchema": {
"primarySource": {
"type": "contacts_schema",
"schemaId": "<string>",
"email": "<string>",
"phone": "<string>",
"userId": "<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>"
},
"additionalSources": [
{
"type": "contacts_schema",
"schemaId": "<string>",
"email": "<string>",
"phone": "<string>",
"userId": "<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>"
}
]
},
"transactionsSchema": [
{
"type": "transactions_schema",
"eventType": "<string>",
"schemaId": "<string>",
"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>",
"metadata": [
"<string>"
],
"schemaId": "<string>"
}
],
"locationsSchema": [
{
"type": "locations_schema",
"schemaId": "<string>",
"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>"
}
]
}
}