Download OpenAPI specification:Download
This is a documentation that covers all of BayEngage's Custom APIs
Receive customer data from a custom app into BayEngage. (Note - This a Protected API and requires Private API key to access it. Don't expose this keys in the browser)
Contact details can be included along with the Email contact. A new contact will be created for the provided email. If contact already exists, contact details will be updated.
| x-client-secret required | string Example: uVY6nwVOOc26xB7e7a74bb988ffa This can be found in the settings page of 'Custom integration' under 'Apps'. You can generate it under the name 'Client Secret (private key)'. |
| x-public-id required | string Example: 7b74ec988ffa This can be found in the settings page of 'Custom integration' under 'Apps'. You can find it under the name 'Client ID'. |
| id | integer This is the customer ID that your maintain in your platform. |
| email required | string This is the email address of the customer. Either email or phone is mandatory. |
| phone | string This is the phone number of the customer. |
| source required | string Default: "api" This is an identification for source of contact creation. The source is mandatory to create the contact. |
| email_subscription required | string The subscription status of the customer. Possible values are active or unsub. The contact is added as subscribed or unsubscribed based on this value. |
| phone_optin_trigger | boolean Enum: true false Indicates whether to trigger an SMS opt-in message to the provided phone number.
Set to |
| phone_subscription | string Possible values are "unverified", "unsub"
|
| phone_existing_subscription | string Possible values is "retain". By using this key user account phone status will not override. |
| tags | object This is for the purpose of grouping. The values are added as shopify tags. |
| custom_fields | object |
| first_name | string This is the customer's first name |
| last_name | string This is the customer's last name |
| address1 | string |
| address2 | string |
| city | string |
| province | string |
| zip | string |
| country | string |
| list_id | string This is the list UUID where your contact have been added to in BayEngage. You can find the List UUID is the list settings page. If this UUID misspelled or not provided your contact will be added into website contact default list. |
{- "id": 984112,
- "email": "johndoe@targetbay.com",
- "phone": "+1xxxxxxxxxx",
- "source": "api",
- "email_subscription": "active",
- "phone_optin_trigger": false,
- "phone_subscription": "unverified",
- "phone_existing_subscription": "retain",
- "tags": [
- "tag1",
- "tag2"
], - "custom_fields": [
- {
- "favourite_color": "blue"
}, - {
- "age": "28"
}
], - "first_name": "John",
- "last_name": "Doe",
- "address1": "Melrose Avenue",
- "address2": 102,
- "city": "Los Angeles",
- "province": "Michigan",
- "zip": 30303,
- "country": "United States",
- "list_id": "58133f44864d"
}Update an Email contact in BayEngage
| x-client-secret required | string Example: uVY6nwVOOc26xB7e7a74bb988ffa This can be found in the settings page of 'Custom integration' under 'Apps'. You can generate it under the name 'Client Secret (private key)'. |
| x-public-id required | string Example: 7b74ec988ffa This can be found in the settings page of 'Custom integration' under 'Apps'. You can find it under the name 'Client ID'. |
| id | string This is the customer ID that your maintain in your platform. |
| email required | string This is the email address of the customer. |
| phone | string This is the phone number of the customer. |
| source required | string Default: "api" This is an identification for source of contact creation. The source is mandatory to create the contact. |
| email_subscription required | string The subscription status of the customer. Possible values are active or unsub. The contact is added as subscribed or unsubscribed based on this value. |
| phone_optin_trigger | boolean Enum: true false Indicates whether to trigger an SMS opt-in message to the provided phone number.
Set to |
| phone_subscription | string Possible values are "unverified", "unsub"
|
| phone_existing_subscription | string Possible values is "retain". By using this key user account phone status will not override. |
| tags | object This is for the purpose of grouping. The values are added as shopify tags. |
| custom_fields | object |
| first_name | string This is the customer's first name |
| last_name | string This is the customer's last name |
| address1 | string |
| address2 | string |
| city | string |
| province | string |
| zip | string |
| country | string |
{- "id": 984112,
- "email": "johndoe@targetbay.com",
- "phone": "+1xxxxxxxxxx",
- "source": "api",
- "email_subscription": "active",
- "phone_optin_trigger": false,
- "phone_subscription": "unverified",
- "phone_existing_subscription": "retain",
- "tags": [
- "tag1",
- "tag2"
], - "custom_fields": [
- {
- "favourite_color": "blue"
}, - {
- "age": "28"
}
], - "first_name": "John",
- "last_name": "Doe",
- "address1": "Melrose Avenue",
- "address2": 102,
- "city": "Los Angeles",
- "province": "Michigan",
- "zip": 30303,
- "country": "United States"
}The API that should be used to fetch all contacts in BayEngage.
| page | integer >= 1 Default: 1 The page number for pagination. |
| limit | integer <= 100 Default: 25 The number of items to return per page. The default value is 25 items and the maximum is 100 per page. |
| fields | string Enum: "tags" "custom_fields" Getting extra details for the customers. |
| x-client-secret required | string Example: uVY6nwVOOc26xB7e7a74bb988ffa This can be found in the settings page of 'Custom integration' under 'Apps'. You can generate it under the name 'Client Secret (private key)'. |
| x-public-id required | string Example: 7b74ec988ffa This can be found in the settings page of 'Custom integration' under 'Apps'. You can find it under the name 'Client ID'. |
Contact details can be included along with the Email contacts. A new contact will be created for the provided email if it does not already exist. The contact details will be updated if eamil contact already exists.
| x-client-secret required | string Example: uVY6nwVOOc26xB7e7a74bb988ffa This can be found in the settings page of 'Custom integration' under 'Apps'. You can generate it under the name 'Client Secret (private key)'. |
| x-public-id required | string Example: 7b74ec988ffa This can be found in the settings page of 'Custom integration' under 'Apps'. You can find it under the name 'Client ID'. |
Array of objects The array that contains the list of subscribers |
{- "subscribers": [
- {
- "id": 984112,
- "email": "johndoe@targetbay.com",
- "phone": "+1xxxxxxxxxx",
- "source": "api",
- "email_subscription": "active",
- "phone_optin_trigger": false,
- "phone_subscription": "unverified",
- "phone_existing_subscription": "retain",
- "tags": [
- "tag1",
- "tag2"
], - "custom_fields": [
- {
- "favourite_color": "blue"
}, - {
- "age": "28"
}
], - "first_name": "John",
- "last_name": "Doe",
- "address1": "Melrose Avenue",
- "address2": 102,
- "city": "Los Angeles",
- "province": "Michigan",
- "zip": 30303,
- "country": "United States",
- "list_id": "58133f44864"
}
]
}Delete an Email contact in BayEngage
| id required | integer The customer ID that you wish to delete |
| x-client-secret required | string Example: uVY6nwVOOc26xB7e7a74bb988ffa This can be found in the settings page of 'Custom integration' under 'Apps'. You can generate it under the name 'Client Secret (private key)'. |
| x-public-id required | string Example: 7b74ec988ffa This can be found in the settings page of 'Custom integration' under 'Apps'. You can find it under the name 'Client ID'. |
Search for an email or phone contact from BayEngage.
| x-client-secret required | string Example: uVY6nwVOOc26xB7e7a74bb988ffa This can be found in the settings page of 'Custom integration' under 'Apps'. You can generate it under the name 'Client Secret (private key)'. |
| x-public-id required | string Example: 7b74ec988ffa This can be found in the settings page of 'Custom integration' under 'Apps'. You can find it under the name 'Client ID'. |
string The email address that you want to search. Either phone or email is mandatory. | |
| phone | string The phone number that you want to search. Either phone or email is mandatory. |
{- "email": "johndoe@targetbay.com",
- "phone": 8967540319
}{- "success": true,
- "code": 200,
- "message": "OK",
- "data": {
- "customer": {
- "customer_id": 107177430,
- "first_name": "John",
- "last_name": "Doe",
- "email": "johndoe@targetbay.com",
- "email_status": "active",
- "phone": "+1xxxxxxxxxx",
- "phone_status": "active",
- "custom_fields": [
- {
- "fav_colour": "Purple"
}
], - "list_id": [
- "b5a775e976b6"
], - "address": [
- {
- "customer_id": 107177430,
- "address_street_1": "102, Melrose Avenue",
- "address_street_2": null,
- "city": "Los Angeles",
- "state": "California",
- "country_code": "US",
- "state_code": null,
- "region": null,
- "city_code": null,
- "country": "USA",
- "zip_code": 75074,
- "created_at": "2024-07-11T09:18:07.000000Z",
- "updated_at": "2024-07-11T09:18:07.000000Z"
}
]
}
}
}Receive category data from a custom app into BayEngage. (Note - This a Protected API and requires Private API key to access it. Don't expose this keys in the browser)
Create category in BayEngage
| x-client-secret required | string Example: uVY6nwVOOc26xB7e7a74bb988ffa A unique key provided for each client. |
| x-public-id required | string Example: 7b74ec988ffa The ID provided for each BayEngage account. |
| category_id required | string Category ID |
| parent_id | string Parent ID |
| name required | string Category Name |
| code required | string Category code |
{- "category_id": 10,
- "parent_id": 1,
- "name": "shirts-men",
- "code": "shirts-men"
}Update category in BayEngage
| x-client-secret required | string Example: uVY6nwVOOc26xB7e7a74bb988ffa A unique key provided for each client. |
| x-public-id required | string Example: 7b74ec988ffa The ID provided for each BayEngage account. |
| category_id required | string Category ID |
| parent_id | string Parent ID |
| name required | string Category Name |
| code required | string Category code |
{- "category_id": 10,
- "parent_id": 1,
- "name": "shirts-men",
- "code": "shirts-men"
}Delete category in BayEngage
| id required | integer The category ID |
| x-client-secret required | string Example: uVY6nwVOOc26xB7e7a74bb988ffa A unique key provided for each client. |
| x-public-id required | string Example: 7b74ec988ffa The ID provided for each BayEngage account. |
Receive product data from a custom app into BayEngage. (Note - This a Protected API and requires Private API key to access it. Don't expose this keys in the browser)
Create product in BayEngage
| x-client-secret required | string Example: uVY6nwVOOc26xB7e7a74bb988ffa This can be found in the settings page of 'Custom integration' under 'Apps'. You can generate it under the name 'Client Secret (private key)'. |
| x-public-id required | string Example: 7b74ec988ffa This can be found in the settings page of 'Custom integration' under 'Apps'. You can find it under the name 'Client ID'. |
| product_id required | integer This is the unique ID of the product. |
| product_title required | string This is the name of the product. |
| description | string A detailed description about the product. |
| vendor | string The vendor of the product. |
| product_type required | string The type of the product. It must either be simple or variant. If your product has multipe variants, use the type 'variant'. |
| product_url | string The URL of the product. |
| product_status | integer The status of the product. If the status is 1, then the product is 'Active'. If 0, then the product is 'Inactive/Draft'. Default is 1. |
Array of objects The category information of the product. | |
| tags | string Tags can be used for filtering. |
required | Array of objects This is the detailed variant information. |
Array of objects The image information of the product. | |
object custom fields store personalized data. |
{- "product_id": 10,
- "product_title": "pink shirt",
- "description": "New Collection pink- t-shirt",
- "vendor": "Puma",
- "product_type": "simple or variant",
- "product_status": "<1 or 0>",
- "product_category": [
- {
- "category_id": 1,
- "category_title": "T-shirt"
}
], - "tags": "t-shirt,mens,pink",
- "variants": [
- {
- "variant_id": 9,
- "variant_title": "Pink-shirt",
- "price": 79.99,
- "sku": "BE-002",
- "position": 1,
- "compare_at_price": 5.99,
- "created_at": "2021-08-04T15:13:40.000Z",
- "updated_at": "2022-02-02T13:25:20.000Z",
- "inventory_quantity": 10
}
], - "images": [
- {
- "is_featured": true,
- "platform_product_id": 7,
- "image_id": 450492,
- "alt": "ppg-defthane-021-01-polyurethane-paint-gloss-liquid-amber-1-gal-can",
- "width": 0,
- "height": 0
}
], - "custom": {
- "bottel": "Glass Water Bottle",
- "pen": "Ballpoint Pen"
}
}Update product in BayEngage
| x-client-secret required | string Example: uVY6nwVOOc26xB7e7a74bb988ffa This can be found in the settings page of 'Custom integration' under 'Apps'. You can generate it under the name 'Client Secret (private key)'. |
| x-public-id required | string Example: 7b74ec988ffa This can be found in the settings page of 'Custom integration' under 'Apps'. You can find it under the name 'Client ID'. |
| product_id required | integer This is the unique ID of the product. |
| product_title required | string This is the name of the product. |
| description | string A detailed description about the product. |
| vendor | string The vendor of the product. |
| product_type required | string The type of the product. It must either be simple or variant. If your product has multipe variants, use the type 'variant'. |
| product_url | string The URL of the product. |
| product_status | integer The status of the product. If the status is 1, then the product is 'Active'. If 0, then the product is 'Inactive/Draft'. Default is 1. |
Array of objects The category information of the product. | |
| tags | string Tags can be used for filtering. |
required | Array of objects This is the detailed variant information. |
Array of objects The image information of the product. | |
object custom fields store personalized data. |
{- "product_id": 10,
- "product_title": "pink shirt",
- "description": "New Collection pink- t-shirt",
- "vendor": "Puma",
- "product_type": "simple or variant",
- "product_status": "<1 or 0>",
- "product_category": [
- {
- "category_id": 1,
- "category_title": "T-shirt"
}
], - "tags": "t-shirt,mens,pink",
- "variants": [
- {
- "variant_id": 9,
- "variant_title": "Pink-shirt",
- "price": 79.99,
- "sku": "BE-002",
- "position": 1,
- "compare_at_price": 5.99,
- "created_at": "2021-08-04T15:13:40.000Z",
- "updated_at": "2022-02-02T13:25:20.000Z",
- "inventory_quantity": 10
}
], - "images": [
- {
- "is_featured": true,
- "platform_product_id": 7,
- "image_id": 450492,
- "alt": "ppg-defthane-021-01-polyurethane-paint-gloss-liquid-amber-1-gal-can",
- "width": 0,
- "height": 0
}
], - "custom": {
- "bottel": "Glass Water Bottle",
- "pen": "Ballpoint Pen"
}
}Delete product in BayEngage
| id required | integer This is the product ID. |
| x-client-secret required | string Example: uVY6nwVOOc26xB7e7a74bb988ffa This can be found in the settings page of 'Custom integration' under 'Apps'. You can generate it under the name 'Client Secret (private key)'. |
| x-public-id required | string Example: 7b74ec988ffa This can be found in the settings page of 'Custom integration' under 'Apps'. You can find it under the name 'Client ID'. |
Receive order data from a custom app into BayEngage. (Note - This a Protected API and requires Private API key to access it. Don't expose this keys in the browser)
Create order in BayEngage
| x-client-secret required | string Example: uVY6nwVOOc26xB7e7a74bb988ffa A unique key provided for each client. |
| x-public-id required | string Example: 7b74ec988ffa The ID provided for each BayEngage account. |
| id required | string Order ID |
| customer_id | string Customer ID |
| email required | string Customer email |
| cart_token required | string Customer cart token |
| phone | string Customer phone number |
| created_at required | string Order created at |
| completed_at | string Order updated at |
| currency | string Currency |
| current_subtotal_price required | string Current subtotal price |
| current_total_discounts | string Current total discounts |
| current_total_price required | string Current total price |
| current_total_tax | string Currency |
Array of objects | |
| refunds | string |
| status required | string Order status |
| financial_status | string Order payment status |
| fulfillment_status | string Order fulfillment status |
| order_number required | string Order Number |
required | Array of objects |
required | Array of objects |
required | Array of objects |
object |
{- "id": 4112002,
- "customer_id": 643456,
- "email": "allutest2@gmail.com",
- "cart_token": "83d188b46c3396d880c20c187f56e679",
- "phone": 8990998999,
- "created_at": "2021-08-04T15:13:40.000Z",
- "completed_at": "2022-02-02T13:25:20.000Z",
- "currency": "USD",
- "current_subtotal_price": 500,
- "current_total_discounts": 0,
- "current_total_price": 500,
- "current_total_tax": 0,
- "discount_codes": [
- {
- "code": "CHECKOUTNOW",
- "amount": 10.55,
- "type": "percentage"
}
], - "refunds": null,
- "status": "open",
- "financial_status": "paid",
- "fulfillment_status": "pending",
- "order_number": 5674898,
- "billing_address": [
- {
- "name": "George",
- "company": "Rane",
- "address1": "4300 Hwy 365 Port Arthur Texas",
- "address2": null,
- "city": "Los Angeles",
- "province": "Michigan",
- "zip": 30303,
- "country": "US",
- "province_code": "LA",
- "country_code": 1
}
], - "line_items": [
- {
- "varient_id": 1,
- "product_id": 4112002,
- "title": "Puma",
- "price": 1000,
- "quantity": 1,
- "sku": "411202gd"
}
], - "shipping_address": [
- {
- "name": "George",
- "company": "Rane",
- "address1": "4300 Hwy 365 Port Arthur Texas",
- "address2": null,
- "city": "Los Angeles",
- "province": "Michigan",
- "zip": 30303,
- "country": "US",
- "province_code": "LA",
- "country_code": 1
}
], - "custom": {
- "flower": "rose"
}
}Update order in BayEngage
| x-client-secret required | string Example: uVY6nwVOOc26xB7e7a74bb988ffa A unique key provided for each client. |
| x-public-id required | string Example: 7b74ec988ffa The ID provided for each BayEngage account. |
| id required | string Order ID |
| customer_id | string Customer ID |
| email required | string Customer email |
| cart_token required | string Customer cart token |
| phone | string Customer phone number |
| created_at required | string Order created at |
| completed_at | string Order updated at |
| currency | string Currency |
| current_subtotal_price required | number Current subtotal price |
| current_total_discounts | number Current total discounts |
| current_total_price required | number Current total price |
| current_total_tax | number Currency |
Array of objects | |
| refunds | string |
| status required | string Order status |
| financial_status | string Order payment status |
| fulfillment_status | string Order fulfillment status |
| order_number required | string Order Number |
required | Array of objects |
Array of objects | |
required | Array of objects |
required | Array of objects |
object |
{- "id": 4112002,
- "customer_id": 643456,
- "email": "allutest2@gmail.com",
- "cart_token": "83d188b46c3396d880c20c187f56e679",
- "phone": 8990998999,
- "created_at": "2021-08-04T15:13:40.000Z",
- "completed_at": "2022-02-02T13:25:20.000Z",
- "currency": "USD",
- "current_subtotal_price": 500,
- "current_total_discounts": 0,
- "current_total_price": 500,
- "current_total_tax": 0,
- "discount_codes": [
- {
- "code": "CHECKOUTNOW",
- "amount": 10.55,
- "type": "percentage"
}
], - "refunds": null,
- "status": "open",
- "financial_status": "paid",
- "fulfillment_status": "pending",
- "order_number": 5674898,
- "billing_address": [
- {
- "name": "George",
- "company": "Rane",
- "address1": "4300 Hwy 365 Port Arthur Texas",
- "address2": null,
- "city": "Los Angeles",
- "province": "Michigan",
- "zip": 30303,
- "country": "US",
- "province_code": "LA",
- "country_code": 1
}
], - "customer": [
- {
- "id": 779887,
- "email": "hilbert@gmail.com",
- "created_at": "2022-01-24T21:28:56.000Z",
- "updated_at": "2022-02-02T13:26:02.000Z",
- "first_name": "Hilbert",
- "last_name": "Ruban",
- "status": "active",
- "tags": null
}
], - "line_items": [
- {
- "varient_id": 1,
- "product_id": 4112002,
- "title": "Puma",
- "price": 1000,
- "quantity": 1,
- "sku": "411202gd"
}
], - "shipping_address": [
- {
- "name": "George",
- "company": "Rane",
- "address1": "4300 Hwy 365 Port Arthur Texas",
- "address2": null,
- "city": "Los Angeles",
- "province": "Michigan",
- "zip": 30303,
- "country": "US",
- "province_code": "LA",
- "country_code": 1
}
], - "custom": {
- "flower": "rose"
}
}Delete order in BayEngage
| id required | integer The order ID |
| x-client-secret required | string Example: uVY6nwVOOc26xB7e7a74bb988ffa A unique key provided for each client. |
| x-public-id required | string Example: 7b74ec988ffa The ID provided for each BayEngage account. |
Receives cart data from a custom app into BayEngage. (Note - This a Protected API and requires Private API key to access it. Don't expose this keys in the browser)
Create cart in BayEngage
| x-client-secret required | string Example: uVY6nwVOOc26xB7e7a74bb988ffa A unique key provided for each client. |
| x-public-id required | string Example: 7b74ec988ffa The ID provided for each BayEngage account. |
| token required | string Cart token |
string User Email ID | |
Array of objects | |
| created_at | string |
{- "token": "83d188b46c3396d880c20c187f56e6752898",
- "email": "primeallu@test.com",
- "line_items": [
- {
- "variant_id": 2,
- "name": "t-shirt",
- "price": 250,
- "quantity": 2,
- "sku": 123
}
], - "created_at": "2023-02-02T13:28:28.939Z"
}Update cart in BayEngage
| x-client-secret required | string Example: uVY6nwVOOc26xB7e7a74bb988ffa A unique key provided for each client. |
| x-public-id required | string Example: 7b74ec988ffa The ID provided for each BayEngage account. |
| token required | string Cart token |
string User Email ID | |
Array of objects |
{- "token": "83d188b46c3396d880c20c187f56e6752898",
- "email": "primeallu@test.com",
- "line_items": [
- {
- "variant_id": 2,
- "name": "t-shirt",
- "price": 250,
- "quantity": 2,
- "sku": 123
}
]
}Receives checkout data from a custom app into BayEngage. (Note - This a Protected API and requires Private API key to access it. Don't expose this keys in the browser)
Create checkout in BayEngage
| x-client-secret required | string Example: uVY6nwVOOc26xB7e7a74bb988ffa A unique key provided for each client. |
| x-public-id required | string Example: 7b74ec988ffa The ID provided for each BayEngage account. |
| checkout_id required | integer |
| token required | string |
| email required | string |
| buyer_accepts_email_marketing required | boolean |
| currency required | string |
required | Array of objects |
| abandoned_checkout_url required | string |
| buyer_accepts_sms_marketing required | boolean |
| sms_marketing_phone required | string |
| total_price required | string |
| total_tax required | string |
| subtotal_price required | string |
required | object |
required | object |
{- "checkout_id": 0,
- "token": "string",
- "email": "string",
- "buyer_accepts_email_marketing": true,
- "currency": "string",
- "line_items": [
- {
- "variant_id": 0,
- "name": "string",
- "quantity": 0,
- "price": 0
}
], - "abandoned_checkout_url": "string",
- "buyer_accepts_sms_marketing": true,
- "sms_marketing_phone": "string",
- "total_price": "string",
- "total_tax": "string",
- "subtotal_price": "string",
- "shipping_address": {
- "first_name": "string",
- "address1": "string",
- "phone": "string",
- "city": "string",
- "zip": "string",
- "province": "string",
- "country": "string",
- "last_name": "string",
- "address2": "string",
- "company": "string",
- "latitude": 0,
- "longitude": 0,
- "name": "string",
- "country_code": "string",
- "province_code": "string"
}, - "customer": {
- "id": 0,
- "email": "string",
- "buyer_accepts_email_marketing": true,
- "first_name": "string",
- "last_name": "string"
}
}Update checkout in BayEngage
| x-client-secret required | string Example: uVY6nwVOOc26xB7e7a74bb988ffa A unique key provided for each client. |
| x-public-id required | string Example: 7b74ec988ffa The ID provided for each BayEngage account. |
| checkout_id required | integer |
| token required | string |
| email required | string |
| buyer_accepts_email_marketing required | boolean |
| currency required | string |
required | Array of objects |
| abandoned_checkout_url required | string |
| buyer_accepts_sms_marketing required | boolean |
| sms_marketing_phone required | string |
| total_price required | string |
| total_tax required | string |
| subtotal_price required | string |
required | object |
required | object |
{- "checkout_id": 0,
- "token": "string",
- "email": "string",
- "buyer_accepts_email_marketing": true,
- "currency": "string",
- "line_items": [
- {
- "variant_id": 0,
- "name": "string",
- "quantity": 0,
- "price": 0
}
], - "abandoned_checkout_url": "string",
- "buyer_accepts_sms_marketing": true,
- "sms_marketing_phone": "string",
- "total_price": "string",
- "total_tax": "string",
- "subtotal_price": "string",
- "shipping_address": {
- "first_name": "string",
- "address1": "string",
- "phone": "string",
- "city": "string",
- "zip": "string",
- "province": "string",
- "country": "string",
- "last_name": "string",
- "address2": "string",
- "company": "string",
- "latitude": 0,
- "longitude": 0,
- "name": "string",
- "country_code": "string",
- "province_code": "string"
}, - "customer": {
- "id": 0,
- "email": "string",
- "buyer_accepts_email_marketing": true,
- "first_name": "string",
- "last_name": "string"
}
}Receives an Activity event into BayEngage (Note - This a Public API and only requires the Public API key to access it.)
An Activity can be created using the API. A new Activity will be created if it does not already exists. If the Activity already exists, an event for that acitivity will be recorded.
| x-public-id required | string Example: INSERT_YOUR_CLIENT_ID The BayEngage tenant's client UUID (You can find it in the admin settings page). |
| key required | string The ID provided for each BayEngage account. |
| activity_name required | string The name of the activity that you wish to create. |
object User properties can contain both System fields and Custom fields. System fields are readily available within BayEngage and the data types of such fields are predefined. Custom fields are customizable and can be used for the purpose of storing additional information about the user. The data type of such custom properties can be defined by the sender using the field_type object. | |
object Any additional data related to the activity can be included in the |
{- "key": "INSERT_YOUR_PUBLIC_KEY",
- "activity_name": "Book rental",
- "user_properties": {
- "email": "johndoe@targetbay.com",
- "phone": "+1xxxxxxxxxx",
- "profile_lookup": "email_phone",
- "first_name": "John",
- "last_name": "Doe",
- "address_street_1": "No 150",
- "address_street_2": "East El Segundo Blvd",
- "city": "Los Angeles",
- "county": "Michigan",
- "state": "California",
- "zip": 90086,
- "country": "USA",
- "gender": "M",
- "list_uuid": "INSERT_YOUR_LIST_UUID",
- "age": "23",
- "be_birthday": "1998-02-26",
- "fav_color": "blue"
}, - "activity_properties": {
- "book_id": 5678,
- "book_title": "To Kill a Mockingbird",
- "book_author": "Harper Lee",
- "isbn": 9780061120084,
- "publisher": "Harper Perennial Modern Classics",
- "publication_date": "2006-10-11T00:00:00.000Z",
- "genre": "Fiction",
- "rental_date": "2023-04-10T00:00:00.000Z",
- "due_date": "2023-05-10T00:00:00.000Z",
- "order_id": 99128,
- "color": "blue",
- "purchased_products": [
]
}
}