redocly logo API docs by Redocly

Zapier API Documentation for BayEngage (1.0.0)

Download OpenAPI specification:Download

E-mail: support@targetbay.com

This is a documentation that covers all of BayEngage's Trigger APIs and Actions APIs.

Action

Receive data from Zapier to BayEngage

Create an Email contact in BayEngage

Contact details can be included along with the Email contact. Customer will be marked as a subscriber.

Request Body schema: application/json
email
required
string
source
required
string
Default: "zapier"

an identification for source of contact creation.

email_subscription
required
string
first_name
string
last_name
string
address_street_1
string
apartment
string
city
string
zip_code
string
country
string
region
string
list_id
string

Responses

Request samples

Content type
application/json
{
  • "email": "johndoe@targetbay.com",
  • "source": "zapier",
  • "email_subscription": "subscribed",
  • "first_name": "John",
  • "last_name": "Doe",
  • "address_street_1": "Melrose Avenue",
  • "apartment": 102,
  • "city": "Los Angeles",
  • "zip_code": 90001,
  • "country": "United States",
  • "region": "California",
  • "list_id": 11021
}

Unsubscribe an Email contact in BayEngage

The Email contact will not receive emails from BayEngage

Request Body schema: application/json
email
required
string
source
required
string
Default: "zapier"

an identification for source of contact creation.

email_subscription
required
string

Responses

Request samples

Content type
application/json
{
  • "email": "johndoe@targetbay.com",
  • "source": "zapier",
  • "email_subscription": "unsubscribed"
}

Search BayEngage by Email

Searches BayEngage for the Email contact and returns the contact details of the customer if found

Request Body schema: application/json
email
required
string
source
required
string
Default: "zapier"

an identification for source of contact creation.

email_subscription
required
string

Responses

Request samples

Content type
application/json
{
  • "email": "johndoe@targetbay.com",
  • "source": "zapier",
  • "email_subscription": "email"
}

Search BayEngage by Phone

Searches BayEngage for the Phone contact and returns the contact details of the customer if found

Request Body schema: application/json
phone
required
string
source
required
string
Default: "zapier"

an identification for source of contact creation.

email_subscription
required
string

Responses

Request samples

Content type
application/json
{
  • "phone": "+1 4565559807",
  • "source": "zapier",
  • "email_subscription": "phone"
}

Trigger

Send data from BayEngage to Zapier

Sends data of new BayEngage customers to Zapier

Sends customer details to Zapier when a customer subscribes to email Via BayEngage

Request Body schema: application/json

Data sent to Zapier

email
string
first_name
string
last_name
string
phone
string
address_street_1
string
apartment
string
city
string
zip_code
string
country
string
region
string

Responses

Request samples

Content type
application/json
{
  • "email": "johndoe@targetbay.com",
  • "first_name": "John",
  • "last_name": "Doe",
  • "phone": "+1 **********",
  • "address_street_1": "Melrose Avenue",
  • "apartment": 102,
  • "city": "Los Angeles",
  • "zip_code": 90001,
  • "country": "United States",
  • "region": "California"
}

Sends data of unsubscribed customers to Zapier

Sends customer details to Zapier when a customer unsubscribes to email Via BayEngage

Request Body schema: application/json

Data sent to Zapier

email
string
date
string

Responses

Request samples

Content type
application/json
{
  • "email": "johndoe@targetbay.com",
  • "date": "2022-07-07T10:10:00.000Z"
}