EmailBison

https://docs.emailbison.com
Admin
EmailBison provides a robust API for managing email-related workflows, including leads, email...
Tokens:27,438
Snippets:361
Trust Score:5.8
Update:3 months ago
Show doc for...
Tokens:
Raw
### Query Parameters Example

Source: https://docs.emailbison.com/get-started/quickstart/notes-and-terminology

Query parameters are appended to the URL starting with '?' and separated by '&'. This example includes 'folder: inbox' and 'status: interested'.

```bash
/api/replies?folder=inbox&status=interested
```

--------------------------------

### HTTP API Enrichment Setup - Query Parameters

Source: https://docs.emailbison.com/low-code-tools/clay/get-requests

Details on setting up query parameters for a GET request in Clay's HTTP API enrichment. Note the specific format for nested filters and array parameters.

```bash
search
john
```

```bash
filters[replies][value]
0
```

```bash
filters[replies][criteria]
=
```

```bash
filters[tag_ids][0]
11
```

```bash
filters[tag_ids][1]
12
```

--------------------------------

### HTTP API Enrichment Setup - GET Request

Source: https://docs.emailbison.com/low-code-tools/clay/get-requests

Configure the HTTP API enrichment in Clay for a GET request to a custom endpoint. Ensure to use the correct key-value pairs for query parameters, including array indexing for duplicate keys.

```bash
https://subdomain.yourdomain.com/api/leads
```

--------------------------------

### PUT Example (Full Replacement)

Source: https://docs.emailbison.com/low-code-tools/clay/enrichments/create-or-update-lead

Demonstrates a full lead replacement using the PUT method. Fields not included in the request body will be removed from the existing lead.

```json
{
  "first_name": "Alex",
  "email": "alex@new.com"
}
```

--------------------------------

### Path Parameter Example

Source: https://docs.emailbison.com/get-started/quickstart/notes-and-terminology

Path parameters like '{campaign_id}' are part of the URL and must be replaced with their actual values.

```bash
GET /api/campaigns/{campaign_id}
```

--------------------------------

### PATCH Example (Partial Update)

Source: https://docs.emailbison.com/low-code-tools/clay/enrichments/create-or-update-lead

Illustrates a partial lead update using the PATCH method. Only the specified fields will be modified, leaving other fields unchanged.

```json
{
  "email": "alex@new.com"
}
```

--------------------------------

### Create Tag Request Example (cURL)

Source: https://docs.emailbison.com/tags/creating-tags

Example of sending a POST request to create a tag named 'Important'. Ensure you replace 'YOUR_SECRET_TOKEN' with your actual secret token.

```bash
curl https://dedi.emailbison.com/api/tags \
--request POST \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--data '{
"name": "Important",
"default": false
}'
```

--------------------------------

### Leads Endpoint Filters

Source: https://docs.emailbison.com/low-code-tools/clay/get-requests

Example filters to apply to the leads endpoint GET request.

```json
search : john
filters: tag_ids = [11, 12]
filters: replies = 0
```

--------------------------------

### Invite Members Endpoint

Source: https://docs.emailbison.com/walkthroughs/creating-template-workspaces

Send a POST request to this endpoint to invite members to the workspace. This is part of the initial setup process for a new project.

```bash
/api/workspaces/v1.1/invite-members
```

--------------------------------

### EmailBison Webhook Setup

Source: https://docs.emailbison.com/walkthroughs/send-slack-message-on-reply

Create a new webhook in EmailBison, providing a name and the n8n Test URL. Subscribe to the 'Contact Replied' event to trigger the webhook.

```text
Name: [Your Webhook Name]
Webhook URL: [Your n8n Test URL]
Events: Contact Replied
```

--------------------------------

### Get Replies for a Lead

Source: https://docs.emailbison.com/master-inbox/fetching-replies

Send a GET request to this endpoint to retrieve replies for a specific lead. Various query parameters are available for filtering the results.

```bash
/api/leads/{lead_id}/replies
```

--------------------------------

### Example Paginated Response (Leads Endpoint)

Source: https://docs.emailbison.com/get-started/pagination

This JSON structure shows a typical paginated response from the leads endpoint, including the data for the current page and links for navigation.

```json
{
    "data": [
        {
            "id": 835910,
            "first_name": "John",
            "last_name": "Doe",
            "email": "JohnDoe@email.com"
        },
        {
            "id": 835898,
            "first_name": "Jane",
            "last_name": "Doe",
            "email": "JaneDoe@email.com"
        }

		... +13 Leads
    ],
    "links": {
        "first": "https://dedi.emailbison.com/api/leads?page=1",
        "last": "https://dedi.emailbison.com/api/leads?page=4",
        "prev": null,
        "next": "https://dedi.emailbison.com/api/leads?page=2"
    },
	"meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 4,
		...
	}
}
```

--------------------------------

### Get Schedule Templates

Source: https://docs.emailbison.com/campaigns/creating-campaigns

Retrieve a list of available schedule templates.

```APIDOC
## GET /api/campaigns/schedule/templates

### Description
Retrieves a list of available schedule templates.

### Method
GET

### Endpoint
/api/campaigns/schedule/templates
```

--------------------------------

### Get Scheduled Emails for a Lead API Endpoint

Source: https://docs.emailbison.com/master-inbox/attaching-leads-to-untracked-replies

Use this GET endpoint to retrieve all scheduled emails associated with a specific lead ID or email address. This is a prerequisite for attaching emails to replies.

```bash
/api/scheduled-emails/{lead_id_or_email}
```

--------------------------------

### Get Campaign Details

Source: https://docs.emailbison.com/campaigns/creating-campaigns

Retrieve the settings for a specific campaign using its ID.

```APIDOC
## GET /api/campaigns/{id}

### Description
Retrieves the settings for a specific campaign.

### Method
GET

### Endpoint
/api/campaigns/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the campaign to retrieve.
```

--------------------------------

### Update Lead with Custom Variables (Python)

Source: https://docs.emailbison.com/leads/custom-variables

Example of updating a lead using Python's requests library, including custom variables in the request body.

```Python
headers = {
'Content-Type': 'application/json',
'Authorization': 'Bearer YOUR_SECRET_TOKEN',
}

json_data = {
	'first_name': 'John',
	'last_name': 'Doe',
	'email': 'john@doe.com',
	'custom_variables': [
		{
			'name': 'phone number',
			'value': '9059999999',
		},
	],
}

response = requests.put('https://dedi.emailbison.com/api/leads/{lead_id}', headers=headers, json=json_data)
```

--------------------------------

### Bulk Upload Leads via API (JavaScript)

Source: https://docs.emailbison.com/leads/creating-a-lead

This JavaScript example demonstrates how to use the FormData API to send a POST request for bulk lead uploading. It appends the CSV file and field mappings to the form data. Note that the Content-Type header is automatically handled by the browser when using FormData.

```JavaScript
let formData = new FormData();

formData.append('file', fs.createReadStream('/Users/Jack/Desktop/list.csv'));
formData.append('name', 'John Does List');
formData.append('columnsToMap[0][first_name]', 'name');
formData.append('columnsToMap[0][last_name]', 'last name');
formData.append('columnsToMap[0][email]', 'email address');
formData.append('columnsToMap[0][company]', 'company name');
formData.append('columnsToMap[0][my_custom_variable]', 'my custom variable');

fetch("https://dedi.emailbison.com/api/leads/bulk/csv",
    {
        body: formData,
        method: "POST"
    });
})
```

--------------------------------

### Update Lead with Custom Variables (cURL)

Source: https://docs.emailbison.com/leads/custom-variables

Example of updating a lead using cURL, including custom variables in the request body.

```Bash
curl https://dedi.emailbison.com/api/leads \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{ \
    "first_name": "John", \
    "last_name": "Doe", \
    "email": "john@doe.com", \
    "custom_variables": [ \
  	{\
  	  "name": "phone number", \
  	  "value": "9059999999" \
  	}
    ] \
  }'
```

--------------------------------

### JSON Body Parameters

Source: https://docs.emailbison.com/get-started/quickstart/notes-and-terminology

This is an example of a JSON object used for request body parameters. It includes basic fields and a custom_variables array.

```json
{
    "name": "John",
    "email": "john@email.com",
    "company": "EmailBison",
    "custom_variables": [
        {
            "name": "phone_number",
            "value": "123-456-7890"
        }
    ]
}
```

--------------------------------

### Update Lead with Custom Variables (JavaScript)

Source: https://docs.emailbison.com/leads/custom-variables

Example of updating a lead using JavaScript's fetch API, including custom variables in the request body.

```JavaScript
fetch('https://dedi.emailbison.com/api/leads/{lead_id}', {
  method: 'PUT',
  headers: {
	'Content-Type': 'application/json',
	Authorization: 'Bearer YOUR_SECRET_TOKEN'
  },
  body: JSON.stringify({
	first_name: 'John',
	last_name: 'Doe',
	email: 'john@doe.com',
	custom_variables: [{
	  name: 'phone number',
	  value: '9059999999'
	}]
  })
})
```

--------------------------------

### POST /api/campaigns/{campaign_id}/schedule

Source: https://docs.emailbison.com/campaigns/creating-campaigns

Creates a schedule for a specific campaign. You can define which days of the week the campaign should run, the start and end times, the timezone, and whether to save the schedule as a template.

```APIDOC
## POST /api/campaigns/{campaign_id}/schedule

### Description
Creates a schedule for a specific campaign. You can define which days of the week the campaign should run, the start and end times, the timezone, and whether to save the schedule as a template.

### Method
POST

### Endpoint
/api/campaigns/{campaign_id}/schedule

### Parameters
#### Path Parameters
- **campaign_id** (string) - Required - The ID of the campaign to schedule.

#### Request Body
- **monday** (boolean) - Required - Whether to schedule for Monday.
- **tuesday** (boolean) - Required - Whether to schedule for Tuesday.
- **wednesday** (boolean) - Required - Whether to schedule for Wednesday.
- **thursday** (boolean) - Required - Whether to schedule for Thursday.
- **friday** (boolean) - Required - Whether to schedule for Friday.
- **saturday** (boolean) - Required - Whether to schedule for Saturday.
- **sunday** (boolean) - Required - Whether to schedule for Sunday.
- **start_time** (string) - Required - The start time for the schedule in HH:MM format.
- **end_time** (string) - Required - The end time for the schedule in HH:MM format.
- **timezone** (string) - Required - The timezone for the schedule (e.g., "America/New_York").
- **save_as_template** (boolean) - Optional - Whether to save this schedule as a template.

### Request Example
```json
{
  "monday": true,
  "tuesday": true,
  "wednesday": true,
  "thursday": true,
  "friday": true,
  "saturday": false,
  "sunday": false,
  "start_time": "09:00",
  "end_time": "17:00",
  "timezone": "America/New_York",
  "save_as_template": false
}
```

### Response
#### Success Response (200)
(Response details not provided in source text)

#### Response Example
(Response example not provided in source text)
```

--------------------------------

### Use Custom Configuration File

Source: https://docs.emailbison.com/email-accounts/bulk-uploader-tool

Specifies a custom configuration file to use instead of the default 'config.txt'. The path can be relative or absolute.

```bash
--config-file "../configs/workspace4.txt"
```

--------------------------------

### Create Workspace Endpoint

Source: https://docs.emailbison.com/walkthroughs/creating-template-workspaces

Use this endpoint to initiate the creation of a new workspace. This is the first step in setting up a new project environment.

```bash
/api/workspaces/v1.1
```

--------------------------------

### Get Campaign Emails for a Lead

Source: https://docs.emailbison.com/master-inbox/fetching-replies

Send a GET request to this endpoint to retrieve campaign emails sent to a specific lead. The lead can be identified by their ID or email address.

```bash
/api/leads/{lead_id_or_email}/sent-emails
```

--------------------------------

### Add Leads from Existing List via API

Source: https://docs.emailbison.com/campaigns/adding-leads-to-a-campaign

Use this endpoint to add all leads from a specified list to a campaign. Adding leads to an active campaign may take up to 5 minutes to sync.

```bash
/api/campaigns/{campaign_id}/leads/attach-lead-list
```

```curl
curl 'https://dedi.emailbison.com/api/campaigns/6/leads/attach-lead-list' \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
    "lead_list_id": 1
  }'
```

```JavaScript
fetch('https://dedi.emailbison.com/api/campaigns/6/leads/attach-lead-list', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    Authorization: 'Bearer YOUR_SECRET_TOKEN'
  },
  body: JSON.stringify({
    lead_list_id: 1
  })
})
```

```Python
headers = {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer YOUR_SECRET_TOKEN',
}

json_data = {
    'lead_list_id': 1,
}

response = requests.post(
    'https://dedi.emailbison.com/api/campaigns/6/leads/attach-lead-list',
    headers=headers,
    json=json_data,
)
```

--------------------------------

### Create Workspace using JavaScript

Source: https://docs.emailbison.com/workspaces/creating-workspaces

This JavaScript snippet demonstrates how to create a workspace using the fetch API. It sends a POST request with the workspace name in the JSON body. Remember to use your super-admin token for authorization.

```javascript
fetch('https://dedi.emailbison.com/api/workspaces/v1.1', {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      Authorization: 'Bearer YOUR_SECRET_TOKEN'
    },
    body: JSON.stringify({
      name: 'New name'
    })
  })
```

--------------------------------

### Create Webhook Endpoint

Source: https://docs.emailbison.com/walkthroughs/creating-template-workspaces

Use this endpoint to set up a webhook for the workspace. This allows the workspace to send event notifications to external services.

```bash
/api/webhook-url
```

--------------------------------

### Create Schedule from Template

Source: https://docs.emailbison.com/campaigns/creating-campaigns

Create a campaign schedule using an existing schedule template.

```APIDOC
## POST /api/campaigns/{campaign_id}/create-schedule-from-template

### Description
Creates a campaign schedule using an existing schedule template.

### Method
POST

### Endpoint
/api/campaigns/{campaign_id}/create-schedule-from-template

### Parameters
#### Path Parameters
- **campaign_id** (string) - Required - The ID of the campaign for which to create the schedule.

#### Request Body
- **schedule_id** (string) - Required - The ID of the schedule template to use.
```

--------------------------------

### Get All Scheduled Emails for a Lead

Source: https://docs.emailbison.com/master-inbox/attaching-leads-to-untracked-replies

Retrieve a list of all scheduled emails associated with a specific lead, identified by their ID or email address.

```APIDOC
## GET /api/scheduled-emails/{lead_id_or_email}

### Description
Fetches all scheduled emails for a given lead.

### Method
GET

### Endpoint
/api/scheduled-emails/{lead_id_or_email}

### Parameters
#### Path Parameters
- **lead_id_or_email** (string) - Required - The ID or email address of the lead.
```

--------------------------------

### Create Workspace using Python

Source: https://docs.emailbison.com/workspaces/creating-workspaces

This Python script uses the requests library to create a new workspace. It sends a POST request with the workspace name and authorization header. Replace YOUR_SECRET_TOKEN with your actual token.

```python
import requests

url = "https://dedi.emailbison.com/api/workspaces/v1.1"

payload = { "name": "New name" }
headers = {
    "Content-Type": "application/json",
    "Authorization": "Bearer YOUR_SECRET_TOKEN"
}

response = requests.post(url, json=payload, headers=headers)
```

--------------------------------

### Accept Workspace Invitation Endpoint

Source: https://docs.emailbison.com/walkthroughs/creating-template-workspaces

Use this endpoint to accept a workspace invitation. This step is crucial for users to gain access to the newly created workspace.

```bash
/api/workspaces/v1.1/accept/{team_invitation_id}
```

--------------------------------

### Create Campaign Schedule

Source: https://docs.emailbison.com/campaigns/creating-campaigns

Use this endpoint to define the days and times a campaign should be active. Ensure you replace YOUR_SECRET_TOKEN with your actual API key.

```bash
curl 'https://dedi.emailbison.com/api/campaigns/{campaign_id}/schedule' \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{ "monday": true, "tuesday": true, "wednesday": true, "thursday": true, "friday": true, "saturday": false, "sunday": false, "start_time": "09:00", "end_time": "17:00", "timezone": "America/New_York", "save_as_template": false }'
```

```JavaScript
fetch('https://dedi.emailbison.com/api/campaigns/{campaign_id}/schedule', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    Authorization: 'Bearer YOUR_SECRET_TOKEN'
  },
  body: JSON.stringify({
    monday: true,
    tuesday: true,
    wednesday: true,
    thursday: true,
    friday: true,
    saturday: false,
    sunday: false,
    start_time: '09:00',
    end_time: '17:00',
    timezone: 'America/New_York',
    save_as_template: false
  })
})
```

```Python
import requests

url = "https://dedi.emailbison.com/api/campaigns/%7Bcampaign_id%7D/schedule"

payload = {
    "monday": True,
    "tuesday": True,
    "wednesday": True,
    "thursday": True,
    "friday": True,
    "saturday": False,
    "sunday": False,
    "start_time": "09:00",
    "end_time": "17:00",
    "timezone": "America/New_York",
    "save_as_template": False
}
headers = {
    "Content-Type": "application/json",
    "Authorization": "Bearer YOUR_SECRET_TOKEN"
}

response = requests.post(url, json=payload, headers=headers)
```

--------------------------------

### Create Workspace using cURL

Source: https://docs.emailbison.com/workspaces/creating-workspaces

Use this cURL command to send a POST request to create a new workspace. Ensure you replace YOUR_SECRET_TOKEN with your actual super-admin token.

```bash
curl https://dedi.emailbison.com/api/workspaces/v1.1 \
    --request POST \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
    --data '{
    "name": "New name"
  }'
```

--------------------------------

### Adding Leads from Existing List

Source: https://docs.emailbison.com/campaigns/adding-leads-to-a-campaign

Attach an entire lead list to a campaign. This process may take up to 5 minutes for synchronization.

```APIDOC
## POST /api/campaigns/{campaign_id}/leads/attach-lead-list

### Description
Adds all leads from a specified lead list to a campaign.

### Method
POST

### Endpoint
/api/campaigns/{campaign_id}/leads/attach-lead-list

### Parameters
#### Path Parameters
- **campaign_id** (integer) - Required - The ID of the campaign to add leads to.

#### Request Body
- **lead_list_id** (integer) - Required - The ID of the lead list to add.

### Request Example
```json
{
  "lead_list_id": 1
}
```

### Response
#### Success Response (200)
(No specific response schema provided in source)

#### Response Example
(No specific response example provided in source)
```

--------------------------------

### Enable Throttling

Source: https://docs.emailbison.com/email-accounts/bulk-uploader-tool

Activates recommended throttling to prevent issues caused by signing into accounts too rapidly. Defaults to false.

```bash
--throttle
```

--------------------------------

### Full API Endpoint URL

Source: https://docs.emailbison.com/get-started/quickstart/notes-and-terminology

Construct the full API endpoint URL by prepending your EmailBison login URL to the relative path.

```bash
https://send.greenmarketing.com/api/tags/attach-to-leads
```

--------------------------------

### Getting Campaign Emails for a Lead

Source: https://docs.emailbison.com/master-inbox/fetching-replies

Retrieve all campaign emails sent to a specific lead. This endpoint allows you to view the history of campaign communications directed at a particular lead.

```APIDOC
## GET /api/leads/{lead_id_or_email}/sent-emails

### Description
Fetches campaign emails sent to a specific lead.

### Method
GET

### Endpoint
/api/leads/{lead_id_or_email}/sent-emails

### Parameters
#### Path Parameters
- **lead_id_or_email** (integer) - Required - The ID or email of the lead.
```

--------------------------------

### Retrieve Campaign IDs using HTTP API Enrichment

Source: https://docs.emailbison.com/low-code-tools/clay/enrichments/import-leads-to-campaign

Use the HTTP API enrichment to fetch Campaign IDs. Ensure your account is authenticated and configure the GET request to the campaigns endpoint.

```bash
https://subdomain.yourdomain.com/api/campaigns
```

--------------------------------

### POST /api/leads

Source: https://docs.emailbison.com/leads/creating-a-lead

Create a single lead by sending a POST request to the /api/leads endpoint. The request requires `first_name`, `last_name`, and `email`, and accepts optional fields like `title`, `company`, `notes`, and custom variables.

```APIDOC
## POST /api/leads

### Description
Create a single lead by sending a POST request to the `/api/leads` endpoint. This allows for individual lead creation with specified details.

### Method
POST

### Endpoint
/api/leads

### Parameters
#### Request Body
- **first_name** (string) - Required - The first name of the lead.
- **last_name** (string) - Required - The last name of the lead.
- **email** (string) - Required - The email address of the lead.
- **title** (string) - Optional - The job title of the lead.
- **company** (string) - Optional - The company the lead is associated with.
- **notes** (string) - Optional - Any additional notes about the lead.
- **custom_variables** (array) - Optional - An array of custom variables for the lead. Each object should have a `name` and `value`.

### Request Example
```json
{
  "first_name": "John",
  "last_name": "Doe",
  "email": "john@doe.com",
  "title": "Engineer",
  "company": "John Doe Company",
  "notes": "Important client",
  "custom_variables": [
    {
      "name": "phone number",
      "value": "9059999999"
    }
  ]
}
```

### Response
#### Success Response (200)
(Response schema not explicitly provided in source, but implies successful creation of a lead.)

#### Response Example
(Response example not explicitly provided in source.)
```

--------------------------------

### Launch Campaign

Source: https://docs.emailbison.com/campaigns/creating-campaigns

Launches a campaign, making it active.

```APIDOC
## PATCH /api/campaigns/{campaign_id}/resume

### Description
Launches the campaign once all necessary steps are completed.

### Method
PATCH

### Endpoint
/api/campaigns/{campaign_id}/resume

### Parameters
#### Path Parameters
- **campaign_id** (string) - Required - The unique identifier of the campaign.
```

--------------------------------

### Remove Tags from Sender Emails (Python)

Source: https://docs.emailbison.com/tags/removing-tags

This Python example shows how to remove tags from sender emails using the requests library. It sends a DELETE request with tag IDs and sender email IDs in the JSON payload.

```python
headers = {
	'Content-Type': 'application/json',
	'Authorization': 'Bearer YOUR_SECRET_TOKEN',
}

json_data = {
	'tag_ids': [1, 2],
	'sender_email_ids': [3, 4]
}

response = requests.delete('https://dedi.emailbison.com/api/tags/attach-to-sender-emails', headers=headers, json=json_data)
```

--------------------------------

### Create API Token Endpoint

Source: https://docs.emailbison.com/walkthroughs/creating-template-workspaces

After creating a workspace, use this endpoint to generate an API token for it. This token will be used for subsequent authenticated requests.

```bash
/api/workspaces/v1.1/{team_id}/api-tokens
```

--------------------------------

### Getting Replies for a Lead

Source: https://docs.emailbison.com/master-inbox/fetching-replies

Retrieve all replies associated with a specific lead. You can filter these replies by various criteria such as search terms, status, folder, read status, campaign ID, sender email ID, and tag IDs.

```APIDOC
## GET /api/leads/{lead_id}/replies

### Description
Fetches replies for a given lead, with optional filtering.

### Method
GET

### Endpoint
/api/leads/{lead_id}/replies

### Parameters
#### Path Parameters
- **lead_id** (integer) - Required - The ID or email of the lead.

#### Query Parameters
- **filters** (object) - Optional - Allows filtering of replies.
  - **search** (string|null) - Search term for filtering replies.
  - **status** (string|null) - Filter by status. One of interested, automated_reply, not_automated_reply.
  - **folder** (string|null) - Filter by folder. One of inbox, sent, spam, bounced, all.
  - **read** (boolean|null) - Filter by read status.
  - **campaign_id** (integer|null) - The ID of the campaign.
  - **sender_email_id** (integer|null) - The ID of the sender email address.
  - **tag_ids** (array|null) - Array of tag IDs to filter by.
```

--------------------------------

### Create Single Lead via API

Source: https://docs.emailbison.com/leads/creating-a-lead

Use this POST request to create a single lead. Required fields are first_name, last_name, and email. Custom variables must be pre-created in your workspace.

```curl
curl https://dedi.emailbison.com/api/leads \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{ \
  "first_name": "John", \
  "last_name": "Doe", \
  "email": "john@doe.com", \
  "title": "Engineer", \
  "company": "John Doe Company", \
  "notes": "Important client", \
  "custom_variables": [ \
    { \
      "name": "phone number", \
      "value": "9059999999" \
    } \
  ] \
}'
```

```JavaScript
fetch('https://dedi.emailbison.com/api/leads', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    Authorization: 'Bearer YOUR_SECRET_TOKEN'
  },
  body: JSON.stringify({
    first_name: 'John',
    last_name: 'Doe',
    email: 'john@doe.com',
    title: 'Engineer',
    company: 'John Doe Company',
    notes: 'Important client',
    custom_variables: [{
      name: 'phone number',
      value: '9059999999'
    }]
  })
})
```

```Python
headers = {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer YOUR_SECRET_TOKEN',
}

json_data = {
    'first_name': 'John',
    'last_name': 'Doe',
    'email': 'john@doe.com',
    'title': 'Engineer',
    'company': 'John Doe Company',
    'notes': 'Important client',
    'custom_variables': [
        {
            'name': 'phone number',
            'value': '9059999999',
        },
    ],
}

response = requests.post('https://dedi.emailbison.com/api/leads', headers=headers, json=json_data)
```

--------------------------------

### Bulk Upload Leads via API (Bash)

Source: https://docs.emailbison.com/leads/creating-a-lead

Use this cURL command to perform a POST request to bulk upload leads. Ensure the Content-Type header is set to multipart/form-data. The request body includes the list name, the CSV file path, and mappings for various lead fields.

```Bash
curl https://dedi.emailbison.com/api/leads/bulk/csv \
  --request POST \
  --header 'Content-Type: multipart/form-data' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data "{
    "name":"John Does list",
    "csv":"/Users/Jack/Desktop/list.csv",
    "columnsToMap[0][first_name]":"name",
    "columnsToMap[0][last_name]":"last name",
    "columnsToMap[0][email]":"email",
    "columnsToMap[0][company]":"company name",
    "columnsToMap[0][my_custom_variable]":"my_custom_variable"
  }"
```

--------------------------------

### Create Campaign Sequence Request

Source: https://docs.emailbison.com/campaigns/creating-campaigns

Use this endpoint to create a sequence of emails for a campaign. The request body requires a title and an array of sequence steps, each with email content, timing, and variant information.

```bash
curl 'https://dedi.emailbison.com/api/campaigns/{campaign_id}/sequence-steps' \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{ \
    "title": "test sequence", \
    "sequence_steps": [ \
        { \
            "email_subject": "Hey {FIRST_NAME}", \
            "order": 1, \
            "email_body": "You should check this {PRODUCT] out!", \
            "wait_in_days": 1, \
            "variant": true, \
            "variant_from_step": 223 \
        }, \
        { \
            "email_subject": "EmailBison is awesome!", \
            "order": 2, \
            "email_body": "Try it now!", \
            "wait_in_days": 1, \
            "variant": true, \
            "variant_from_step": 1, \
            "thread_reply": true \
        } \
    ] \
}'
```

```javascript
fetch('https://dedi.emailbison.com/api/campaigns/{campaign_id}/sequence-steps', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer YOUR_SECRET_TOKEN'
  },
  body: JSON.stringify({
    'title': 'test sequence',
    'sequence_steps': [
      {
        'email_subject': 'Hey {FIRST_NAME}',
        'order': 1,
        'email_body': 'You should check this {PRODUCT] out!',
        'wait_in_days': 1,
        'variant': true,
        'variant_from_step': 223
      },
      {
        'email_subject': 'EmailBison is awesome!',
        'order': 2,
        'email_body': 'Try it now!',
        'wait_in_days': 1,
        'variant': true,
        'variant_from_step': 1,
        'thread_reply': true
      }
    ]
  })
});
```

```python
import requests

headers = {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer YOUR_SECRET_TOKEN',
}

json_data = {
    'title': 'test sequence',
    'sequence_steps': [
        {
            'email_subject': 'Hey {FIRST_NAME}',
            'order': 1,
            'email_body': 'You should check this {PRODUCT] out!',
            'wait_in_days': 1,
            'variant': True,
            'variant_from_step': 223,
        },
        {
            'email_subject': 'EmailBison is awesome!',
            'order': 2,
            'email_body': 'Try it now!',
            'wait_in_days': 1,
            'variant': True,
            'variant_from_step': 1,
            'thread_reply': True,
        },
    ],
}

response = requests.post(
    'https://dedi.emailbison.com/api/campaigns/{campaign_id}/sequence-steps',
    headers=headers,
    json=json_data,
)
```

--------------------------------

### Enable Visible Browsers

Source: https://docs.emailbison.com/email-accounts/bulk-uploader-tool

Spawns visible browsers instead of headless ones. It is recommended to use `--browsers 1` when this flag is enabled.

```bash
--no-headless
```

--------------------------------

### Invite a Member to a Workspace (cURL)

Source: https://docs.emailbison.com/workspaces/inviting-and-accepting-members

Use this cURL command to send a POST request to invite a registered user to a workspace. Ensure you replace YOUR_SECRET_TOKEN with your actual secret token.

```bash
curl https://dedi.emailbison.com/api/workspaces/v1.1/invite-members \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{ 
  "email": "example@example.com",
  "role": "admin"
}'
```

--------------------------------

### Add Individual Leads by IDs via API

Source: https://docs.emailbison.com/campaigns/adding-leads-to-a-campaign

Use this endpoint to add specific leads to a campaign by their IDs. Adding leads to an active campaign may take up to 5 minutes to sync.

```bash
/api/campaigns/{campaign_id}/leads/attach-leads
```

```curl
curl 'https://dedi.emailbison.com/api/campaigns/6/leads/attach-leads' \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
    "lead_ids": [1,2,3]
  }'
```

```JavaScript
fetch('https://dedi.emailbison.com/api/campaigns/6/leads/attach-leads', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    Authorization: 'Bearer YOUR_SECRET_TOKEN'
  },
  body: JSON.stringify({
    lead_ids: [1, 2, 3]
  })
})
```

```Python
headers = {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer YOUR_SECRET_TOKEN',
}

json_data = {
    'lead_ids': [1,2,3,],
}

response = requests.post('https://dedi.emailbison.com/api/campaigns/6/leads/attach-leads', headers=headers, json=json_data)
```

--------------------------------

### Create User API Endpoint

Source: https://docs.emailbison.com/workspaces/creating-users

Use this endpoint to programmatically register a new user associated with an email account if they haven't registered yet. The request requires a JSON body with user details.

```bash
curl https://dedi.emailbison.com/api/workspaces/v1.1/users \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{ 
  "name": "John Doe",
  "password": "securepasswordlol",
  "email": "example@example.com",
  "role": "admin"
}'
```

--------------------------------

### Specify Browser Driver

Source: https://docs.emailbison.com/email-accounts/bulk-uploader-tool

Selects the technology to control the browsers. Options are 'rod' or 'chromedp'. Defaults to 'rod'.

```bash
--driver rod
```

--------------------------------

### Bulk Upload Leads via CSV

Source: https://docs.emailbison.com/leads/creating-a-lead

Use this endpoint to bulk upload leads by sending a POST request with a CSV file and mapping information. Do not set the 'content-type' header as it will be automatically set to 'multipart/form-data'.

```APIDOC
## POST /api/leads/bulk/csv

### Description
Bulk upload leads with a POST request to this endpoint. The request takes a name for the lead list, the CSV file, and mappings for columns.

### Method
POST

### Endpoint
/api/leads/bulk/csv

### Parameters
#### Request Body
- **name** (string) - Required - The name of the lead list that will be created.
- **csv** (FILE) - Required - The CSV file.
- **columnsToMap[first_name][]** (string) - Required - The name of the CSV header column that corresponds to `first_name` on EmailBison.
- **columnsToMap[last_name][]** (string) - Required - The name of the CSV header column that corresponds to `last_name` on EmailBison.
- **columnsToMap[email][]** (string) - Required - The name of the CSV header column that corresponds to `email` on EmailBison.
- **columnsToMap[{OTHER}][]** (string) - Optional - The remaining fields you would like to map, including custom variables, each getting their own field.

### Request Example
```bash
curl https://dedi.emailbison.com/api/leads/bulk/csv \
  --request POST \
  --header 'Content-Type: multipart/form-data' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data "{
    "name":"John Does list",
    "csv":"/Users/Jack/Desktop/list.csv",
    "columnsToMap[0][first_name]":"name",
    "columnsToMap[0][last_name]":"last name",
    "columnsToMap[0][email]":"email",
    "columnsToMap[0][company]":"company name",
    "columnsToMap[0][my_custom_variable]":"my_custom_variable"
  }"
```

```javascript
let formData = new FormData();

formData.append('file', fs.createReadStream('/Users/Jack/Desktop/list.csv'));
formData.append('name', 'John Does List');
formData.append('columnsToMap[0][first_name]', 'name');
formData.append('columnsToMap[0][last_name]', 'last name');
formData.append('columnsToMap[0][email]', 'email address');
formData.append('columnsToMap[0][company]', 'company name');
formData.append('columnsToMap[0][my_custom_variable]', 'my custom variable');

fetch("https://dedi.emailbison.com/api/leads/bulk/csv",
    {
        body: formData,
        method: "POST"
    });
```

```python
url = 'https://dedi.emailbison.com/api/leads/bulk/csv'
fp = '/Users/Jack/Desktop/list.csv'

files = {'file': open(fp, 'rb')}
payload = {
            'name': 'my list'
            'columnsToMap[0][first_name]':'name',
            'columnsToMap[0][last_name]':'last name',
            'columnsToMap[0][email]':'email',
            'columnsToMap[0][company]':'company name',
            'columnsToMap[0][my_custom_variable]':'my_custom_variable'
        }

response = requests.post(url, files=files, data=payload)
```
```

--------------------------------

### Create New Campaign Schedule

Source: https://docs.emailbison.com/campaigns/creating-campaigns

Create a new campaign schedule without using a template.

```APIDOC
## POST /api/campaigns/{campaign_id}/schedule

### Description
Creates a new campaign schedule.

### Method
POST

### Endpoint
/api/campaigns/{campaign_id}/schedule

### Parameters
#### Path Parameters
- **campaign_id** (string) - Required - The ID of the campaign for which to create the schedule.

#### Request Body
- **monday** (boolean) - Required - Whether the schedule includes Monday.
```

--------------------------------

### Invite a Member to a Workspace (JavaScript)

Source: https://docs.emailbison.com/workspaces/inviting-and-accepting-members

This JavaScript snippet demonstrates how to invite a registered user to a workspace using the fetch API. Replace YOUR_SECRET_TOKEN with your actual secret token.

```JavaScript
fetch('https://dedi.emailbison.com/api/workspaces/v1.1/invite-members', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    Authorization: 'Bearer YOUR_SECRET_TOKEN'
  },
  body: JSON.stringify({
    email: 'example@example.com',
    role: 'admin'
  })
})
```

--------------------------------

### Adding Leads by Their IDs

Source: https://docs.emailbison.com/campaigns/adding-leads-to-a-campaign

Add individual leads to a campaign by providing their unique IDs. Synchronization may take up to 5 minutes.

```APIDOC
## POST /api/campaigns/{campaign_id}/leads/attach-leads

### Description
Adds individual leads, specified by their IDs, to a campaign.

### Method
POST

### Endpoint
/api/campaigns/{campaign_id}/leads/attach-leads

### Parameters
#### Path Parameters
- **campaign_id** (integer) - Required - The ID of the campaign to add leads to.

#### Request Body
- **lead_ids** (array) - Required - An array containing the IDs of the leads to add.

### Request Example
```json
{
  "lead_ids": [1, 2, 3]
}
```

### Response
#### Success Response (200)
(No specific response schema provided in source)

#### Response Example
(No specific response example provided in source)
```

--------------------------------

### Campaign Schedule Parameters

Source: https://docs.emailbison.com/campaigns/creating-campaigns

Configure the days, times, and timezone for your campaign schedule.

```APIDOC
## Campaign Schedule

### Description
Defines the scheduling parameters for a campaign.

### Parameters
#### Request Body
- **tuesday** (boolean) - Required - Whether the schedule includes Tuesday.
- **wednesday** (boolean) - Required - Whether the schedule includes Wednesday.
- **thursday** (boolean) - Required - Whether the schedule includes Thursday.
- **friday** (boolean) - Required - Whether the schedule includes Friday.
- **saturday** (boolean) - Required - Whether the schedule includes Saturday.
- **sunday** (boolean) - Required - Whether the schedule includes Sunday.
- **start_time** (string) - Required - The start time in HH:MM format. Example: `09:00`
- **end_time** (string) - Required - The end time in HH:MM format. Example: `17:00`
- **timezone** (string) - Required - The timezone of the schedule. Use the formatted string after the `=>` symbol. e.g. "America/Los_Angeles"
```

--------------------------------

### Create API Key

Source: https://docs.emailbison.com/workspaces/creating-api-keys

Send a POST request to this endpoint to generate a new API key for a specified workspace. The request body must include the name for the new API key.

```APIDOC
## POST /api/workspaces/v1.1/{workspace_id}/api-tokens

### Description
Generates a new API key for a specified workspace.

### Method
POST

### Endpoint
/api/workspaces/v1.1/{workspace_id}/api-tokens

### Parameters
#### Path Parameters
- **workspace_id** (integer) - Required - The ID of the workspace you want to generate a key for.

#### Request Body
- **name** (string) - Required - The name of the API key you are creating.

### Request Example
```json
{
  "name": "New token"
}
```

### Response
#### Success Response (200)
- **api_key** (string) - The generated API key.
- **name** (string) - The name of the API key.
- **created_at** (string) - The timestamp when the API key was created.
```

--------------------------------

### Create Workspace

Source: https://docs.emailbison.com/workspaces/creating-workspaces

Send a POST request to the /api/workspaces/v1.1 endpoint with a JSON body containing the name of the workspace to be created. This operation requires a super-admin key for authentication.

```APIDOC
## POST /api/workspaces/v1.1

### Description
Creates a new workspace.

### Method
POST

### Endpoint
/api/workspaces/v1.1

### Parameters
#### Request Body
- **name** (string) - Required - The name of the workspace to create.

### Request Example
```json
{
  "name": "New name"
}
```

### Response
#### Success Response (200)
(Response details not provided in source)

#### Response Example
(Response example not provided in source)
```

--------------------------------

### Set Concurrent Browsers

Source: https://docs.emailbison.com/email-accounts/bulk-uploader-tool

Specifies the number of browsers to spawn concurrently. The minimum is 1 and the maximum is 16. Defaults to 6.

```bash
--browsers 4
```

--------------------------------

### Create API Key using cURL

Source: https://docs.emailbison.com/workspaces/creating-api-keys

Use this cURL command to create a new API key for a specific workspace. Ensure you replace YOUR_SECRET_TOKEN with your actual token and adjust the workspace ID and key name as needed.

```curl
curl 'https://dedi.emailbison.com/api/workspaces/v1.1/54/api-tokens' \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "name": "New token"
}'
```

--------------------------------

### Retrieve Campaign Sequence Steps

Source: https://docs.emailbison.com/campaigns/creating-campaigns

Retrieves the sequence steps configured for a specific campaign.

```APIDOC
## GET /api/campaigns/{campaign_id}/sequence-steps

### Description
Retrieves the campaign sequences steps.

### Method
GET

### Endpoint
/api/campaigns/{campaign_id}/sequence-steps

### Parameters
#### Path Parameters
- **campaign_id** (string) - Required - The unique identifier of the campaign.
```

--------------------------------

### EmailBison Attach Leads Endpoint

Source: https://docs.emailbison.com/low-code-tools/clay/post-requests

This is the endpoint URL for attaching leads to a campaign. Replace `{campaign_id}` with the actual campaign ID or use Clay's dynamic referencing.

```bash
https://subdomain.yourdomain.com/api/campaigns/{campaign_id}/leads/attach-leads
```

--------------------------------

### Create Campaign

Source: https://docs.emailbison.com/campaigns/creating-campaigns

Send a POST request to /api/campaigns to create a new campaign. You must pass the 'name' body parameter.

```APIDOC
## POST /api/campaigns

### Description
Creates a new campaign.

### Method
POST

### Endpoint
/api/campaigns

### Parameters
#### Request Body
- **name** (string) - Required - The name of the campaign you wish to create.

### Response
#### Success Response (200)
- **campaign_id** (string) - The ID of the newly created campaign.
```

--------------------------------

### Path Parameter Substitution

Source: https://docs.emailbison.com/get-started/quickstart/notes-and-terminology

Replace the placeholder '{campaign_id}' with the specific campaign ID to form a valid request URL.

```bash
/api/campaigns/27
```

--------------------------------

### Invite a Member to a Workspace (Python)

Source: https://docs.emailbison.com/workspaces/inviting-and-accepting-members

This Python code uses the requests library to invite a registered user to a workspace. Remember to replace YOUR_SECRET_TOKEN with your actual secret token.

```Python
import requests

url = "https://dedi.emailbison.com/api/workspaces/v1.1/invite-members"

payload = {
    "email": "example@example.com",
    "role": "admin"
}
headers = {
    "Content-Type": "application/json",
    "Authorization": "Bearer YOUR_SECRET_TOKEN"
}

response = requests.post(url, json=payload, headers=headers)
```

--------------------------------

### Bulk Upload Leads via API (Python)

Source: https://docs.emailbison.com/leads/creating-a-lead

This Python script uses the 'requests' library to perform a bulk lead upload. It opens the CSV file in binary read mode and sends it along with payload data containing the list name and column mappings.

```Python
url = 'https://dedi.emailbison.com/api/leads/bulk/csv'
fp = '/Users/Jack/Desktop/list.csv'

files = {'file': open(fp, 'rb')}
payload = {
            'name': 'my list'
            'columnsToMap[0][first_name]':'name',
            'columnsToMap[0][last_name]':'last name',
            'columnsToMap[0][email]':'email',
            'columnsToMap[0][company]':'company name',
            'columnsToMap[0][my_custom_variable]':'my_custom_variable'
        }

response = requests.post(url, files=files, data=payload)
```

--------------------------------

### Leads Endpoint Path

Source: https://docs.emailbison.com/low-code-tools/clay/get-requests

The base path for the leads endpoint in EmailBison.

```bash
/api/leads
```
Tokens:
Raw