Introduction

Welcome to the BuzzBoard Ignite API v4.0 documentation.

The BuzzBoard Ignite API is an easy way to tap into BuzzBoard and use its features and functionalities to create your own BuzzBoard-powered applications for web, mobile and desktop.

We are always open to feedback, drop an email to support@buzzboard.com and let us know what you want to see from the BuzzBoard Ignite API.

PROPERTIES

The (meta) object is used across all APIs.

Field Type Description
count

Number

The number of items returned in this object.
last_generated

Number

Date and time the object was last generated in Unix timestamp format.
prospect_id

String

The unique identifier of the prospect.(e.g.) https://apis.buzzboard.com/v4.0/competition?prospect_id=1

status

Number

The HTTP status code of the operation.
message

String

A message applying to the last operation.

Users

The Users API allows you to retrieve information about users in your account. You can retrieve all the users at a time, or just a single user. This is read only access.

PROPERTIES

The following properties are for use with the Users API.

Field Type Description
id

Number

Unique identifier of the user.
username

String

Username of the user.
first_name

String

First name of the user.
last_name

String

Last name of the user.
phone

String

Phone number of the user.
mobile

String

Mobile number of the user.
email

String

Email of the user.
user_type

String

Type of the user. Possible values :

  • Project Manager
  • Sales Rep
  • Partner Manager
reporting_to

String

The name or identifier of the manager the user reports to.
profile_limit

Number

Profile limit of the user for the current month.
created_at

Number

Date and time of the creation in Unix timestamp format.
updated_at

Number

Date and time of the last update to the user in Unix timestamp format.

ENDPOINTS

Users - List v4.0

Returns all users.

https://apis.buzzboard.com/v4.0/users

Returns all active users of partner.

curl -X GET "https://apis.buzzboard.com/v4.0/users"
-H "Authorization: Bearer $ACCESS_TOKEN" 
{
  "data": [
    {
      "id": 1,
      "username": "john@gmail.com",
      "first_name": "John",
      "last_name": "Lynna",
      "phone": "(441) 234-5687",
      "mobile": "9235687921",
      "email": "john@gmail.com",
      "user_type": "Project Manager",
      "reporting_to": null,
      "profile_limit": 250,
      "created_at": 1373023946,
      "updated_at": 1484632107
    },
    {
      "id": 2,
      "username": "danae@gmail.com",
      "first_name": "Denae",
      "last_name": "Cai",
      "phone": "(441) 234-568790",
      "mobile": "9234568330",
      "email": "danae@gmail.com",
      "user_type": "Sales Rep",
      "reporting_to": "John Lynna",
      "profile_limit": 250,
      "created_at": 1373024026,
      "updated_at": 1488449664
    }
  ],
  "meta": {
    "count": 2
  }
}

Users - Get Details v4.0

Returns a single user by the unique user Id.

https://apis.buzzboard.com/v4.0/users/{:id}

Parameters

Field Type Description
id Required

Number

Unique identifier of the user.

Retrieve a user with Id 1

curl -X GET "https://apis.buzzboard.com/v4.0/users/1"
-H "Authorization: Bearer $ACCESS_TOKEN" 
{
  "data": {
    "id": 1,
    "username": "john@gmail.com",
    "first_name": "John",
    "last_name": "Lynna",
    "phone": "(441) 234-5687",
    "mobile": null,
    "email": "john@gmail.com",
    "user_type": "Project Manager",
    "reporting_to": null,
    "profile_limit": 250,
    "created_at": 1373023946,
    "updated_at": 1484632107
  }
}

Prospect

The Prospect API allows you to add, update, change owners, regenerate and provide other details of a prospect.

PROPERTIES

The following properties are for use with the Prospect API.

Field Type Description
business_name

String

Name of the prospect.
website

String

Prospect's website. Required unless city and state fields are provided.
phone

String

Prospect's phone number.
contact_info

Object

Prospect's contact information. For more information about the contact_info object see Contact Info.
address

Object

Prospect's address information. For more information about the address object see Address.
primary_category_id

Number

Primary Category Id of the prospect.
secondary_category_id

Number

Secondary Category Id of the prospect.
score

Object

Score for the prospect. For more information about the score object see Score.
crm_sync New

Boolean

Status for whether or not you need to sync the inserted record into enabled CRM (Sales Force / Base CRM).
callback_url New

String

Callback URL to be invoked by the API method you're calling after it's done.
keywords

Array

Array of keywords, such as. [ "My Business for Everything", "By Business", "Only Business"]
external_id

String

An Id you can use to link the BuzzBoard prospect to local records.
creator_id

Number

Unique identifier of the user who created the prospect.
created_at

Number

Date and time of the creation in Unix timestamp format.
updated_at

Number

Date and time of the last update to the prospect in Unix timestamp format.

ENDPOINTS

Prospect - List v4.0

Returns all available prospects.

https://apis.buzzboard.com/v4.0/prospects

Parameters

Field Type Description
id

Number

Unique identifier of the user.

page_no

Number

Starting page number. By default page number starts from 1. If page_no is not specified, the returned records will start from first page.https://apis.buzzboard.com/v4.0/prospects?page_no=1

page_limit

Number

Number of records to be returned per page.https://apis.buzzboard.com/v4.0/prospects?page_limit=10

callback_url

String

Callback URL to be invoked by the API method you're calling after it's done.

crm_sync

Boolean

Status for whether or not you need to sync the inserted record into enabled CRM (Sales Force / Base CRM).

query

JSON Object

Filter Parameters

  • Business name (The name of the business)https://apis.buzzboard.com/v4.0/prospects?owner_id=1&query={"business_name":"pizza"}
  • Score (This is the BuzzScore that is given to each prospect based on it's digital health)https://apis.buzzboard.com/v4.0/prospects?owner_id=1&query={"score":"10-20"}
  • Archive (The prospects which are marked as Archived by the user)https://apis.buzzboard.com/v4.0/prospects?owner_id=1&query={"archive": "1"}
  • Favorites (The prospects which are marked as Favorite by the user)https://apis.buzzboard.com/v4.0/prospects?owner_id=1&query={"favorites": "1"}
  • Monitored (The prospects which are marked by the user for monitoring)https://apis.buzzboard.com/v4.0/prospects?owner_id=1&query={"monitored": "1"}
  • Stage ids (Unique identifier of the stages)https://apis.buzzboard.com/v4.0/prospects?owner_id=1&query={"stage_ids":[712, 713]}
  • Propensity Ids (Unique identifier of the propensity)https://apis.buzzboard.com/v4.0/prospects?owner_id=1&query={"propensity_ids":[541,554,555]}
  • Sort by (The option to sort prospects by using different filters)https://apis.buzzboard.com/v4.0/prospects?owner_id=1&query={"sort_by":"buzzscore/added_date/business_name"}
  • Sort order (The order in which you want to sort the prospects)https://apis.buzzboard.com/v4.0/prospects?owner_id=1&query={"sort_order": "ASC/DESC"}
  • City (The city where the prospect is located)https://apis.buzzboard.com/v4.0/prospects?owner_id=1&query={"city":"Fredericksburg"}
  • State (The state in which the prospect is located)https://apis.buzzboard.com/v4.0/prospects?owner_id=1&query={"state":"VA"}
  • Country (The country where the prospect is located)https://apis.buzzboard.com/v4.0/prospects?owner_id=1&query={"country":"United Kingdom"}
  • Postal code (The postal code where the prospect's address falls into)https://apis.buzzboard.com/v4.0/prospects?owner_id=1&query={"zipcode":"22407"}
  • Line1 (It contains the primary address information)https://apis.buzzboard.com/v4.0/prospects?owner_id=1&query={"line1":"5717 Plank Rd"}
  • Date (Returns prospect list in the defined date range)https://apis.buzzboard.com/v4.0/prospects?owner_id=1&query={"date":"2017-04-17@^2017-04-18"}
latitude

Number

The latitude of prospect’s location.

longitude

Number

The longitude of prospect's location. 

curl -X GET "https://apis.buzzboard.com/v4.0/prospects?owner_id=1&query={"business_name":"pizza"}
-H "Authorization: Bearer $ACCESS_TOKEN"
{
  "data": [
    {
      "id": 1,
      "external_id": null,
      "business_name": "Carlos Pizza",
      "website": null,
      "phone": "(718) 894-7915",
      "address": {
        "line1": "7402 Metropolitan Ave",
        "city": "Middle Village",
        "zip": "11379",
        "state": "NY",
        "country": "United States"
      },
      "latitude": "40.7126348",
      "longitude": "-73.8781243",
      "score": {
        "value": 28,
        "color": "#0000E9"
      },
      "created_at": 1492675357,
      "creator_id": 1009,
      "updated_at": 1492675387
    },
    {
      "id": 2,
      "external_id": null,
      "business_name": "Pizza",
      "website": "http://www.pizza.com",
      "phone": "(111) 111-1111",
      "address": {
        "line1": "43930 Farmwell Hunt Plaza",
        "city": "Ashburn",
        "zip": "20147",
        "state": "VA",
        "country": "United States"
      },
      "latitude": "39.0236717",
      "longitude": "-77.4809538",
      "score": {
        "value": 55,
        "color": "#CEA900"
      },
      "created_at": 1491994487,
      "creator_id": 1009,
      "updated_at": 1491994513
    }
  ],
  "meta": {
    "count": 2
  }
}

Prospect - Create v4.0

Creates a new prospect.

https://apis.buzzboard.com/v4.0/prospects

Parameters

Field Type Description
business_name Required

String

Name of the prospect.

website

String

Prospect's website. Required unless city and state fields are provided.

phone

String

Prospect's phone number.

contact_info

Object

Prospect's contact information. For more information about the contact_info object see Contact Info.

address

Object

Prospect's address information. For more information about the address object see Address.

primary_category_id

Number

Primary category Id of the prospect.

secondary_category_id

Number

Secondary category Id of the prospect.

crm_sync

Boolean

Status for whether or not you need to sync the inserted record into enabled CRM (Sales Force / Base CRM).

keywords

Array

Array of keywords, such as. [ "My Business for Everything", "By Business", "Only Business"]

external_id

String

An identifier you can use to link the BuzzBoard prospect to local records.

owner_id

Number

The unique identifier of the user.(e.g.) https://apis.buzzboard.com/v4.0/prospects?owner_id=1009

Creates a new prospect 'Design Services Company' with Id 1.

curl -X POST "https://apis.buzzboard.com/v4.0/prospects"
-H "Authorization: Bearer $ACCESS_TOKEN"
-H "Content-Type: application/json"
-d '{
  "data": {
    "business_name": "Design Services Company",
    "website": "http://www.designservice.com",
    "phone": "(541) 754-3010",
    "contact_info": {
      "first_name": "Mathew",
      "last_name": "Cooper",
      "email": "mathew@designservice.com",
      "mobile": "5417543011",
      "title": "Mr",
      "phone": "(541) 754-3010"
    },
    "address": {
      "line1": "151th Street",
      "city": "Miami",
      "zip": "12011",
      "state": "FL",
      "country": "United States"
    },
    "primary_category_id": 57,
    "secondary_category_id": 45,
    "keywords": [
      "My Business for Everything",
      "By Business",
      "Only Business"
    ],
    "external_id": "1237"
  }
}'
{
  "prospect_id": 1,
  "data": {
    "id": 1,
    "business_name": "Design Services Company",
    "website": "http://www.designservice.com",
    "phone": "(541) 754-3010",
    "contact_info": {
      "first_name": "Mathew",
      "last_name": "Cooper",
      "email": "mathew@designservice.com",
      "mobile": "5417543011",
      "title": "Mr",
      "phone": "(541) 754-3010"
    },
    "address": {
      "line1": "151th Street",
      "city": "Miami",
      "zip": "12011",
      "state": "FL",
      "country": "United States"
    },
    "primary_category_id": 57,
    "secondary_category_id": 45,
    "score": {
      "value": "P",
      "color": "#0000E9"
    },
    "external_id": "1237",
    "created_at": 1489750959,
    "updated_at": 1489750959
  }
}

Prospect - Create Many v4.0

Creates multiple prospects and a callback URL that will be invoked by the API method you are calling.

https://apis.buzzboard.com/v4.0/prospects/createmany

Parameters

Field Type Description
business_name Required

String

Name of the prospect.

website

String

Prospect's website. Required unless city and state fields are provided.

phone

String

Prospect's phone number.

contact_info

Object

Prospect's contact information. For more information about the contact_info object see Contact Info.

address

Object

Prospect's address information. For more information about the address object see Address.

primary_category_id

Number

Primary Category Id of the prospect.

secondary_category_id

Number

Secondary Category Id of the prospect.

crm_sync

Boolean

Status for whether or not you need to sync the inserted record into enabled CRM (Sales Force/Base CRM).

keywords

Array

Array of keywords, such as. [ "My Business for Everything", "By Business", "Only Business"]

external_id

String

An Id you can use to link BuzzBoard prospect to local records.

callback_url

String

Callback URL to be invoked by the API method you're calling after it's done.

owner_id

Number

The unique identifier of the user.(e.g.) https://apis.buzzboard.com/v4.0/prospects/createmany?owner_id=1009 

curl -X POST "https://apis.buzzboard.com/v4.0/prospects/createmany"
-H "Authorization: Bearer $ACCESS_TOKEN"
-H "Content-Type: application/json"
-d '{
"data": {
    "prospects": [
      {
        "business_name": "Dev Company",
        "website": "https://dev.com",
        "phone": "(908) 998-9898",
        "contact_info": {
          "first_name": "john",
          "last_name": "Mathew",
          "email": "johnmathew@gm.com",
          "mobile": "5417543011",
          "title": "Mr",
          "phone": "(541) 754-3010"
        },
        "address": {
          "line1": "34 Old Compton Street",
          "city": "London",
          "zip": "12365",
          "state": "FL",
          "country": "United States"
        },
        "primary_category_id": 57,
        "secondary_category_id": 45,
        "keywords": [
          "My Business",
          "Business",
          "Only Business"
        ]
      },
      {
        "business_name": "Dev2 Company",
        "website": "https://devcom.com",
        "phone": "(988) 998-9898",
        "contact_info": {
          "first_name": "johns",
          "last_name": "Mathews",
          "email": "johnmathesw@gm.com",
          "mobile": "5418543011",
          "title": "Mr",
          "phone": "(541) 754-8010"
        },
        "address": {
          "line1": "34 Old Compton Street",
          "city": "London",
          "zip": "23654",
          "state": "FL",
          "country": "United States"
        },
        "primary_category_id": 57,
        "secondary_category_id": 45,
        "keywords": [
          "Business",
          "Dev Business",
          "Only Dev Business"
        ]
      }
    ],
    "callback_url": "https://requestb.in/176r7bl1",
    "owner_id": 1009
  }
}'
{
  "data": {
    "job_id": "lXERIj1xZKIbFMIR"
  }
}

Prospect - Search Many v4.0

Searches multiple prospects based on the requested search parameters and a callback URL will be invoked by the API method you are calling.

https://apis.buzzboard.com/v4.0/prospects/searchmany

Parameters

Field Type Description
search_params Required

Object

Prospect's possible search parameters. You can send array of search parameters. For more information about the parameters to send in the search_params object see Search Params Info.

auto_add Required

Boolean

For automatically adding prospects to BuzzBoard. It would get added if the value is true. If false the matched results will be returned to the callback_url.

owner_id

Number

The unique identifier of the user.

callbackurl

String

Callback URL to be invoked by the API method you're calling after it's done. 

curl -X POST "https://apis.buzzboard.com/v4.0/prospects/searchmany"
-H "Authorization: Bearer $ACCESS_TOKEN"
-H "Content-Type: application/json"
-d '{
"data": {
  "search_params":
	[
          {
            "business_name": "Erwin Pearl Inc",
            "business_zipcode": "77056",
            "business_phone": "",
            "business_website" : "",
            "combination_type" : "BZ"	 
          },
          {
            "business_name": "Walgreens",
            "business_zipcode": "",
            "business_phone": "7037290693",
            "combination_type": "BP"	
         },
	 {
            "business_name": "Brittany Club",
            "business_zipcode": "",
            "business_phone": "",
            "combination_type": "BZ"	
         }
	],
	"auto_add": false,
        "owner_id": 1009,
	"callbackurl": "enter the call back url here"
  }
}'

Prospect - Update v4.0

Updates your prospect information. If the prospect is not available in your account, this query will return an error.

https://apis.buzzboard.com/v4.0/prospects/{:id}

Parameters

Field Type Description
id Required

Number

Unique identifier of the prospect.

business_name Required

String

Name of the prospect.

website

String

Prospect's website. Required unless city and state fields are provided.

phone

String

Prospect's phone number.

contact_info

Object

Prospect's contact information. For more information about thecontact_info object see Contact Info.

address

String

Prospect's address information. For more information about the address object see Address.

latitude

Number

The latitude of prospect’s location.

longitude

Number

The longitude of prospect’s location.

favourite

Number

The prospects which are marked as Favorite by the user.

is_monitored

Number

The prospects which are marked by the user for monitoring.

monitored_on

Number

This gives information on when the prospect was monitored.

primary_category_id

Number

Primary Category Id of the prospect.

secondary_category_id

Number

Secondary Category Id of the prospect.

score

Object

Score for the prospect. For more information about the score object see Score.

keywords

Array

Array of keywords, such as. [ "My Business for Everything", "By Business", "Only Business"]

external_id

String

An Id you can use to link BuzzBoard prospect to local records.

created_at

Number

Date and time of the creation in Unix timestamp format.

updated_at

Number

Date and time of the last update to the user in Unix timestamp format.

Updates a prospect with Id 1.

curl -X PUT "https://apis.buzzboard.com/v4.0/prospects/1"
-H "Authorization: Bearer $ACCESS_TOKEN" 
-H "Content-Type: application/json"
-d '{
  "data": {
    "business_name": "Design Services Company",
    "website": "http://www.designservice.com",
    "phone": "(541) 754-3111",
    "contact_info": {
      "first_name": "Mathew",
      "last_name": "Cooper",
      "email": "mathew@designservice.com",
      "mobile": "5417543011",
      "title": "Mr",
      "phone": "(541) 754-3010"
    },
    "address": {
      "line1": "151th Street",
      "city": "Miami",
      "zip": "12011",
      "state": "FL",
      "country": "United States"
    },
    "primary_category_id": 57,
    "secondary_category_id": 45,
    "keywords": [
      "My Business for Everything",
      "By Business",
      "Only Business"
    ],
    "external_id": "1237"
  }
}'
{
  "data": {
    "id": 1,
    "business_name": "Design Services Company",
    "website": "http://www.designservice.com",
    "phone": "(541) 754-3111",
    "contact_info": {
      "first_name": "Mathew",
      "last_name": "Cooper",
      "email": "mathew@designservice.com",
      "mobile": "5417543011",
      "title": "Mr",
      "phone": "(541) 754-3010"
    },
    "address": {
      "line1": "151th Street",
      "city": "Miami",
      "zip": "12011",
      "state": "FL",
      "country": "United States"
    },
    "primary_category_id": 57,
    "secondary_category_id": 45,
    "score": {
      "value": "P",
      "color": "#0000E9"
    },
    "external_id": "1237",
    "created_at": 1489750959,
    "updated_at": 1489790989
  }
}

Prospect - Change Owner v4.0

Changes the ownership of a prospect.

https://apis.buzzboard.com/v4.0/prospects/changeowner

Parameters

Field Type Description
prospect_id Required

Number

The unique identifier of the prospect.

new_owner_id Required

Number

The unique identifier of the new owner.

Updates a prospect owner with prospect Id 1.

curl -X PUT "https://apis.buzzboard.com/v4.0/prospects/changeowner" 
-H "Authorization: Bearer $ACCESS_TOKEN" 
-H "Content-Type: application/json"
-d '{
  "data": {
    "prospect_id":1,
    "new_owner_id": 2
  }
}'
{
  "status": 200,
  "message": "Success"
}

Prospect - Regenerate v4.0

Regenerates a prospect to reanalyze the data and update the details.

https://apis.buzzboard.com/v4.0/prospects/regenerate

Parameters

Field Type Description
prospect_id Required

Number

The unique identifier of the prospect.

Regenerates a prospect with Id 1.

curl -X POST "https://apis.buzzboard.com/v4.0/prospects/regenerate"
-H "Authorization: Bearer $ACCESS_TOKEN"
-H "Content-Type: application/json"
-d '{
  "data": {
    "prospect_id":1
  }
}' 
{
  "status": 200,
  "message": "Success"
}

Prospect - Get Details v4.0

Retrieves details of a single prospect such as business name, contact information, and address.

https://apis.buzzboard.com/v4.0/prospects/1

Parameters

Field Type Description
prospect_id Required

Number

Unique identification of the prospect. 

curl -X GET "https://apis.buzzboard.com/v4.0/prospects/1"
-H "Authorization: Bearer $ACCESS_TOKEN"
{
  "prospect_id": 1,
  "data": {
    "id": 1,
    "business_name": "Design Services Company",
    "website": "http://www.designservice.com",
    "phone": "(541) 754-3010",
    "contact_info": {
      "first_name": "Mathew",
      "last_name": "Cooper",
      "email": "mathew@designservice.com",
      "mobile": "5417543011",
      "title": "Mr",
      "phone": "(541) 754-3010"
    },
    "address": {
      "line1": "151th Street",
      "city": "Miami",
      "zip": "12011",
      "state": "FL",
      "country": "United States"
    },
    "latitude": "28.0136642",
    "longitude": "-82.7827283",
    "favourite": 0,
    "is_monitored": 0,
    "monitored_on": null,
    "primary_category_id": 414,
    "secondary_category_id": 973,
    "score": {
      "value": 69,
      "color": "#80ca01"
    },
    "external_id": "1237",
    "created_at": 1489735430,
    "updated_at": 1491993018
  }
}

Prospect - Assets v4.0

Retrieves a list of the documents (assets) available for the prospect.

https://apis.buzzboard.com/v4.0/prospects/assets

Parameters

Field Type Description
prospect_id Required

Number

The unique identifier of the prospect.(e.g.) https://apis.buzzboard.com/v4.0/prospects/assets?prospect_id=1

title

String

The document title.

type

String

The type of document.

url

String

The URL of the asset. 

curl -X GET "https://apis.buzzboard.com/v4.0/prospects/assets?prospect_id=1" 
-H "Authorization: Bearer $ACCESS_TOKEN"
{
  "data": [
    {
      "title": "Business Insights",
      "type": "insights_business",
      "url": "https://sales.buzzboard.com/assetsurl_887cc3a363"
    },
    {
      "title": "Category Insights",
      "type": "insights_category",
      "url": "https://sales.buzzboard.com/assetsurl_887cc35678"
    },
    {
      "title": "Game Plan",
      "type": "insights_gameplan",
      "url": "https://sales.buzzboard.com/assetsurl_887cc28976"
    },
    {
      "title": "Profile Report",
      "type": "profile",
      "url": "https://sales.buzzboard.com/assetsurl_887cc10954"
    },
    {
      "title": "Competitors Report",
      "type": "competitors_pdf",
      "url": "https://sales.buzzboard.com/assetsurl_887cc01234"
    }
  ]
}

Prospect - Search Params

The search_params object is used for search and searchmany.

Field Type Description
business_name

String

Name of the prospect. Required when requested in combination_type.

zipcode

String

Prospect's zipcode. Required when requested in combination_type.

website

String

Prospect's website. Required when requested in combination_type.

phone

String

Prospect's phone number. Required when requested in combination_type.

combination_type Required

String

Any one of the combination needs to be passed in the search parameters: "BZ - Business Name & Zip", "BP - Business Name & Phone", "PH - Phone", "WS - Website".

Prospect - Contact Info

The contact_info object is used across all Prospects APIs.

Field Type Description
first_name

String

First name of the contact.

last_name

String

Last name of the contact.

email

String

Email address of the contact.

phone

String

Phone number of the contact.

mobile

String

Mobile number of the contact.

title

String

Title of the contact.

Prospect - Address

The address object is used across all Prospects APIs.

Field Type Description
line1

String

Line 1 of the address such as number, street, suite, or apartment number.

city

String

City name.

zip

String

Postal code.

state

String

State name.

country

String

Country name.

Prospect - Score

The score object is used across all Prospects APIs.

Field Type Description
value

Number

This is the BuzzScore that is given to each prospect based on it's digital health.

color

String

Color of the stage, in hexadecimal format (such as "#0343ff").

Engagements

The Engagements API allows you to manage your notes and/or reminders. You can create, delete, and update a note, or set a reminder associated with a note. You can also retrieve a single note or reminder or get the entire list.

PROPERTIES

The following properties are for use with the Engagements API.

Field Type Description
id

Number

The unique identifier of the note/reminder.
type New

String

Name of the type of resource. Possible values:

  • note
  • reminder
  • email
(e.g.) https://apis.buzzboard.com/v4.0/engagements?type="email"
title

String

The note/reminder title.
content

Text

The note/reminder content.
reminder_date

Number

Date and time that we should send you a reminder in UNIX timestamp format.
google_sync New

Boolean

Status for whether or not you need to sync the inserted record into 'Google Calendar'.
crm_sync New

Boolean

Status for whether or not you need to sync the inserted record into enabled CRM (Sales Force / Base CRM).
creator_id

Number

The unique identifier for the creator of the note/reminder.
created_at

Number

Date and time of the creation in Unix timestamp format.
updated_at

Number

Date and time of the last update to the engagement in Unix timestamp format.

ENDPOINTS

Engagements - List v4.0

Retrieves a list of all notes, reminders and emails associated with a prospect.

https://apis.buzzboard.com/v4.0/engagements

Parameters

Field Type Description
prospect_id Required

Number

The unique identifier of the prospect.(e.g.) https://apis.buzzboard.com/v4.0/engagements?prospect_id=1

page_no

Number

Starting page number. By default page number starts from 1. If page_no is not specified, the returned records will start from first page. (e.g.) https://apis.buzzboard.com/v4.0/engagements?page_no=1

page_limit

Number

Number of records to be returned per page.(e.g.) https://apis.buzzboard.com/v4.0/engagements?page_limit=10

type Required

String

Name of the type of resource. Possible values:

  • note
  • reminder
  • email
(e.g.) https://apis.buzzboard.com/v4.0/engagements?type="email"

Returns list of all engagements of a prospect with Id 1.

curl -X GET "https://apis.buzzboard.com/v4.0/engagements?prospect_id=1&type=reminder"
-H "Authorization: Bearer $ACCESS_TOKEN"
{
  "data": [
    {
      "id": 1,
      "type": "reminder",
      "title": "Ray Design Works",
      "content": "I tried the much touted Penultimate, and Sundry Notes, and UYH but this is the only app that thoroughly delighted me. It has everything I wanted.",
      "reminder_date": 14900046111,
      "creator_id": 1,
      "created_at": 1491991137,
      "updated_at": 1492093357
    },
    {
      "id": 2,
      "type": "reminder",
      "title": "Astra World",
      "content": "For nearly sixty years, Notes has presented interesting, informative, and well-written articles on music librarianship, music bibliography, the music trade, ...",
      "reminder_date": 1490004610,
      "creator_id": 1,
      "created_at": 1491915863,
      "updated_at": 1491917394
    }
  ],
  "meta": {
    "count": 2
  }
}

Engagements - Create v4.0

Adds a new note or sets a reminder for a prospect.

https://apis.buzzboard.com/v4.0/engagements

Parameters

Field Type Description
prospect_id Required

Number

The unique identifier of the prospect.

type Required

String

Name of the type of resource. Possible values:

  • note
  • reminder
(e.g.) https://apis.buzzboard.com/v4.0/engagements?type="note"

title Required

String

Engagement title.

content

Text

The engagement content.

reminder_date

Number

Date and time that we should send you a reminder in UNIX timestamp format.

google_sync

Boolean

Status for whether or not you need to sync the inserted record into 'Google Calendar'.

crm_sync

Boolean

Status for whether or not you need to sync the inserted record into enabled CRM (Sales Force / Base CRM).

Creates an engagement with Id 1.

curl -X POST "https://apis.buzzboard.com/v4.0/engagements"
-H "Authorization: Bearer $ACCESS_TOKEN"
-H "Content-Type: application/json"

-d '{
  "data": {
    "prospect_id": 1,
    "type": "reminder",
    "title": "Follow up Mathew on a deal",
    "content": "Follow up Mathew on a deal over phone call.",
    "reminder_date": 1490023847
  }
}'
{
  "data": {
    "id": 1,
    "prospect_id": 1,
    "title": "Follow up Mathew on a deal",
    "type": "reminder",
    "content": "Follow up Mathew on a deal over phone call.",
    "reminder_date": 1490023847,
    "creator_id": 1,
    "created_at": 1489732132,
    "updated_at": 1489732132
  }
}

Engagements - Update v4.0

Updates the information of an existing note or reminder associated with a prospect. If the prospect is not available in your account, the request will return an error.

https://apis.buzzboard.com/v4.0/engagements/{:id}

Parameters

Field Type Description
id Required

Number

Unique identifier of an engagement.

prospect_id

Number

The unique identifier of the prospect.

title

String

Engagement title.

content

Text

The engagement content.

reminder_date

Number

Date and time that we should send you a reminder in UNIX timestamp format.

type Required

String

Name of the type of resource. Possible values:

  • note
  • reminder
(e.g.) https://apis.buzzboard.com/v4.0/engagements?type="note"

Updates engagement with Id 1.

curl -X PUT "https://apis.buzzboard.com/v4.0/engagements/1"
-H "Authorization: Bearer $ACCESS_TOKEN"
-H "Content-Type: application/json"
-d '{
    "data": {
      "title": "Call Customer",
      "content": "Need to discuss on proposal",
      "reminder_date": 1490023947
    }
}'
{
  "data": {
    "id": 1,
    "prospect_id": 1,
    "title": "Call Customer",
    "content": "Need to discuss on proposal",
    "reminder_date": 1490023947,
    "creator_id": 1,
    "created_at": 1490023456,
    "updated_at": 1490023719
  }
}

Engagements - Delete v4.0

Deletes any existing note or reminder associated with a prospect. If the Engagement Id does not exist, this request will return an error.

Once deleted, you won't be able to undo this action.

https://apis.buzzboard.com/v4.0/engagements/{:id}

Parameters

Field Type Description
id Required

Number

Engagement Id to be deleted.

type

String

Name of the type of resource. Possible values:

  • note
  • reminder
(e.g.) https://apis.buzzboard.com/v4.0/engagements?type="note"

Delete an engagement with Id 1.

curl -X DELETE "https://apis.buzzboard.com/v4.0/engagements/1"
-H "Authorization: Bearer $ACCESS_TOKEN"
"HTTP/1.1 204 No Content"

Engagements - Get Details v4.0

Retrieves details of a particular Engagement note or reminder.

https://apis.buzzboard.com/v4.0/engagements/{:id}

Parameters

Field Type Description
id Required

Number

Engagement Id.

type

String

Name of the type of resource. Possible values:

  • note
  • reminder
(e.g.) https://apis.buzzboard.com/v4.0/engagements?type="note"

Returns details of an engagement with Id 1.

curl -X GET "https://apis.buzzboard.com/v4.0/engagements/1"
-H "Authorization: Bearer $ACCESS_TOKEN"
{
  "data": {
    "id": 1,
    "prospect_id": 1,
    "type": "reminder",
    "title": "Call Customer",
    "content": "Need to discuss on proposal",
    "reminder_date": 1489984299,
    "creator_id": 1,
    "created_at": 1489683385,
    "updated_at": 1489684248
  }
}

Contacts

The Contacts API allows you to manage your contacts. A contact represents an individual (for example,. Justin Taylor) or an organization (like BuzzBoard). You can create, delete and update your contacts. You can retrieve individual customers, as well as a list of all customers.

PROPERTIES

The following properties are for use with the Contacts API.

Field Type Description
id

Number

Unique identifier of the contact.
prospect_id

Number

Prospect Id associated with the contact.
first_name

String

The contact's first name.
last_name

String

The contact's last name.
phone

String

The contact's phone number.
mobile

String

The contact's mobile number.
title

String

The contact's title.
email

String

The contact's email address.
google_sync New

Boolean

Status for whether or not you need to sync the inserted record into 'Google Contacts'.
crm_sync New

Boolean

Status for whether or not you need to sync the inserted record into enabled CRM (Sales Force / Base CRM).
creator_id

Number

The unique identifier of the user who created the contact.
created_at

Number

Date and time of the creation in Unix timestamp format.
updated_at

Number

Date and time of the last update to the contact in Unix timestamp format.

ENDPOINTS

Contacts - List v4.0

Retrieves all contact information available for a prospect.

https://apis.buzzboard.com/v4.0/contacts

Parameters

Field Type Description
prospect_id Required

Number

Prospect Id of the associate. (e.g.) https://apis.buzzboard.com/v4.0/contacts?prospect_id=1

page_no

Number

Page number to start from. Page numbering starts at 1 and omitting the page parameter will return the first page.(e.g.) https://apis.buzzboard.com/v4.0/contacts?page_no=1

page_limit

Number

Number of records to return per page.(e.g.) https://apis.buzzboard.com/v4.0/contacts?page_limit=10

Returns all contacts available to the prospect with Id 1.

curl -X GET "https://apis.buzzboard.com/v4.0/contacts?prospect_id=1"
-H "Authorization: Bearer $ACCESS_TOKEN"
-H "Content-Type: application/json"
{
  "data": [
    {
      "id": 1,
      "prospect_id": 1,
      "contact_name": "Mark Taylor",
      "email": "marktaylor@buzzboard.com",
      "phone": "(541) 888-1234",
      "mobile": "5418881233",
      "title": "Mr",
      "creator_id": 1,
      "created_at": 1489752816,
      "updated_at": 1489752816
    },
    {
      "id": 2,
      "prospect_id": 1,
      "contact_name": "Mark Styne",
      "email": "markstyne@buzzboard.com",
      "phone": "(541) 754-3010",
      "mobile": "5417543011",
      "title": "Mr",
      "creator_id": 1,
      "created_at": 1489752449,
      "updated_at": 1489752449
    }
  ],
  "meta": {
    "count": 2
  }
}

Contacts - Create v4.0

Creates a new contact.

https://apis.buzzboard.com/v4.0/contacts

Parameters

Field Type Description
prospect_id Required

Number

Prospect Id associated.

first_name

String

The contact's first name.

last_name Required

String

The contact's last name.

email

String

The contact's email address.

phone

String

The contact's phone number.

mobile

String

The contact's mobile number.

title

String

The contact's title.

google_sync

Boolean

Status for whether or not you need to sync the inserted record into 'Google Contacts'.

crm_sync

Boolean

Status for whether or not you need to sync the inserted record into enabled CRM (Sales Force / Base CRM).

Adds a new contact 'John Markson' to a prospect with Id 1.

curl -X POST "https://apis.buzzboard.com/v4.0/contacts" 
-H "Authorization: Bearer $ACCESS_TOKEN" 
-H "Content-Type: application/json" 

-d '{
    "data": {
      "prospect_id": 1,
      "first_name": "John",  
      "last_name": "Markson",
      "email": "john.markson@buzzboard.com",
      "title": "Mr",
      "phone": "(541) 754-3010",
      "mobile": "5417543011"
    }
}'
{
  "data": {
    "id": 1,
    "prospect_id": 1,
    "first_name": "John",
    "last_name": "Markson",
    "email": "john.markson@buzzboard.com",
    "phone": "(541) 754-3010",
    "mobile": "5417543111",
    "title": "Mr",
    "creator_id": 1,
    "created_at": 1489653230,
    "updated_at": 1489653230
  }
}

Contacts - Update v4.0

Updates a contact information.

https://apis.buzzboard.com/v4.0/contacts/{:id}

Parameters

Field Type Description
id Required

Number

Contact Id.

prospect_id

Number

Prospect Id associated.

first_name

String

The contact's first name.

last_name Required

String

The contact's last name.

email

String

The contact's email address.

phone

String

The contact's phone number.

mobile

String

The contact's mobile number.

title

String

The contact's title.

Updates first_name, last_name, mobile, email and title of a contact with Id 1.

curl -X PUT "https://apis.buzzboard.com/v4.0/contacts/1"
-H "Authorization: Bearer $ACCESS_TOKEN"
-H "Content-Type: application/json" 
-d '{ 
    "data": {
        "first_name": "Mark",
        "last_name": "Johnson",
        "phone":"(541) 888-1234"
        "mobile": "5418881233",
        "title": "Mr",
        "email": "mark.johnson@buzzboard.com"
      }
}'
{
  "data": {
    "id": 1,
    "prospect_id": 1,
    "first_name": "Mark",
    "last_name": "Johnson",
    "email": "mark.johnson@buzzboard.com",
    "phone": "(541) 888-1234",
    "mobile": "5418881233",
    "title": "Mr",
    "creator_id": 1,
    "created_at": 1489653230,
    "updated_at": 2597986459
  }
}

Contacts - Delete v4.0

Deletes a contact information. Once deleted, you won't be able to undo this action. If the Engagement Id does not exist, this request will return an error.

https://apis.buzzboard.com/v4.0/contacts/{:id}

Parameters

Field Type Description
id Required

Number

Contact Id.

Delete a contact with Id 1.

curl -X DELETE "https://apis.buzzboard.com/v4.0/contacts/1"
-H "Authorization: Bearer $ACCESS_TOKEN"
"HTTP/1.1 204 No Content"

Contacts - Get Details v4.0

Retrieves a single contact available to the user.

https://apis.buzzboard.com/v4.0/contacts/{:id}

Parameters

Field Type Description
id Required

Number

The Id of the contact.

Returns details of a contact with Id 1.

curl -X GET "https://apis.buzzboard.com/v4.0/contacts/1"
-H "Authorization: Bearer $ACCESS_TOKEN"
-H "Content-Type: application/json"
{
  "data": {
    "id": 1,
    "prospect_id": 1,
    "first_name": "John",
    "last_name": "Markson",
    "email": "john.markson@buzzboard.com",
    "phone": "(541) 754-3010",
    "mobile": "5417543111",
    "title": "Mr",
    "creator_id": 1,
    "created_at": 1489653230,
    "updated_at": 1489653230
  }
}

Presentations

The Presentations API allows you to list the presentations.

PROPERTIES

The following properties are for use with the Presentations API.

Field Type Description
id

Number

The unique identifier of the presentation.
title

String

The presentation's title.
url

String

The presentation's URL.
creator_id

Number

Unique identifier of the user who created the presentation.
created_at

Number

Date and time of the creation in Unix timestamp format.
updated_at

Number

Date and time of the last update to the presentation in Unix timestamp format.

ENDPOINTS

Presentations - List v4.0

Retrieves all presentations related to a prospect.

https://apis.buzzboard.com/v4.0/presentations

Parameters

Field Type Description
prospect_id Required

Number

Prospect Id associated with presentation.(e.g.) https://apis.buzzboard.com/v4.0/presentations?prospect_id=1

page_no

Number

Page number to start from. Page numbering starts at 1 and omitting the page parameter will return the first page.(e.g.) https://apis.buzzboard.com/v4.0/presentations?page_no=1

page_limit

Number

Number of records to return per page.(e.g.) https://apis.buzzboard.com/v4.0/presentations?page_limit=10

Returns list of all presentations of a prospect with Id 1, starting from page number 1 with 10 presentations list per page.

curl -X GET "https://apis.buzzboard.com/v4.0/presentations?prospect_id=1&page_no=1&page_limit=10"
-H "Authorization: Bearer $ACCESS_TOKEN"
{
  "data": [
    {
      "id": 1,
      "title": "Presentation 1 - Globe Institute Of Technology",
      "url": "https://demobuzzboardsales.s3.amazonaws.com/includes/uploads/presentation_creator/Presentation5-GlobeInstituteOfTechnology_2016-10-20-08-59-30-AM.pdf",
      "creator_id": 1,
      "created_at": 1476968384,
      "updated_at": 1476967384
    },
    {
      "id": 2,
      "title": "Presentation 2 - Globe Institute Of Technology",
      "url": "https://demobuzzboardsales.s3.amazonaws.com/includes/uploads/presentation_creator/Presentation4-GlobeInstituteOfTechnology_2016-10-20-07-30-11-AM.pdf",
      "creator_id": 1,
      "created_at": 1476963043,
      "updated_at": 1476969043
    }
  ],
  "meta": {
    "count": 2
  }
}

Categories

The Categories API allows you to list the categories.

PROPERTIES

The following properties are for use with the Categories API.

Field Type Description
id

Number

Unique identifier of the Category.
name

String

Unique name of the Category.

ENDPOINTS

Categories - List v4.0

Retrieves a list of categories available.

https://apis.buzzboard.com/v4.0/categories

Returns a list of all categories available.

curl -X GET "https://apis.buzzboard.com/v4.0/categories"
-H "Authorization: Bearer $ACCESS_TOKEN
{
  "data": [
    {
      "id": 1,
      "name": "Abbey"
    },
    {
      "id": 2,
      "name": "Abortion Clinic"
    }
  ],
  "meta": {
    "count": 2
  }
}

Proposals

The Proposals API allows you to list the proposals of the prospect.

PROPERTIES

The following properties are for use with the Proposals API.

Field Type Description
prospect_id

Number

The unique identifier of the prospect.
id

Number

The unique identifier of the proposal.
name

String

Name of the proposal.
opportunity

Number

Opportunity value of the proposal.
pdf_url

String

URL to the proposal.

ENDPOINTS

Proposals - List v4.0

Retrieves a list of all proposals of a prospect.

https://apis.buzzboard.com/v4.0/proposal

Parameters

Field Type Description
prospect_id Required

Number

The unique identifier of the prospect.(e.g.) https://apis.buzzboard.com/v4.0/proposal?prospect_id=1

Returns list of all proposals of a prospect with Id 1.

curl -X GET "https://apis.buzzboard.com/v4.0/proposal?prospect_id=1" 
-H "Authorization: Bearer $ACCESS_TOKEN"
{
  "data": [
    {
      "id": 1,
      "name ": "Option 1 - Search + TLC + ReTargeting",
      "opportunity": "22982.00",
      "pdf_url": "https://sales.buzzboard.com/assetsurl_342d2b0361"
    },
    {
      "id": 2,
      "name ": "Search Only",
      "opportunity": "13748.00",
      "pdf_url": "https://sales.buzzboard.com/assetsurl_959d2b1707"
    },
    {
      "id": 3,
      "name ": "$1500 Wisdom Teeth",
      "opportunity": "22838.20",
      "pdf_url": "https://sales.buzzboard.com/assetsurl_261d2b2351"
    },
    {
      "id": 4,
      "name ": "Tooth implants",
      "opportunity": "26948.00",
      "pdf_url": "https://sales.buzzboard.com/assetsurl_366d2b3716"
    },
    {
      "id": 5,
      "name ": "1000 Jaw correction",
      "opportunity": "34589.50",
      "pdf_url": "https://sales.buzzboard.com/assetsurl_634d2b4145"
    },
    {
      "id": 6,
      "name ": "Search Dr Franc Henze",
      "opportunity": "68127.00",
      "pdf_url": "https://sales.buzzboard.com/assetsurl_816d2b5196"
    }
  ],
  "meta": {
    "count": 6
  }
}

Stages

The Stages API allows you to list the stages.

PROPERTIES

The following properties are for use with the Stages API.

Field Type Description
id

Number

The unique identifier of the Stage.
name

String

The unique name of the Stage.
color

String

Color of the stage, in hexadecimal format (such as “#0343ff�)

ENDPOINTS

Stages - List v4.0

Retrieves a list of stages available.

https://apis.buzzboard.com/v4.0/stages

Returns list of all stages available.

curl -X GET "https://apis.buzzboard.com/v4.0/stages"
-H "Authorization: Bearer $ACCESS_TOKEN"
{
  "data": [
    {
      "id": 1,
      "name": "Prospecting",
      "color": "#FFC300"
    },
    {
      "id": 2,
      "name": "Qualified",
      "color": "#87CEEB"
    },
    {
      "id": 3,
      "name": "Won",
      "color": "#228B22"
    },
    {
      "id": 4,
      "name": "Lost",
      "color": "#FF5733"
    },
    {
      "id": 5,
      "name": "Unqualified",
      "color": "#FF5733"
    }
  ],
  "meta": {
    "count": 5
  }
}

Profile

The Profile API allows you to list the Profile elements.

PROPERTIES

The following properties are for use with the Profile API.

Field Type Description
prospect_id

Number

The unique identifier of the prospect.(e.g.) https://apis.buzzboard.com/v4.0/profile/elements?prospect_id=1
grade

Object

Prospect's grade information. For more information about the grade object see Grade.

ENDPOINTS

Profile - Elements v4.0

Retrieves a list of profile elements.

https://apis.buzzboard.com/v4.0/profile/elements

Parameters

Field Type Description
prospect_id Required

Number

The unique identifier of the prospect.(e.g.) https://apis.buzzboard.com/v4.0/profile/elements ?prospect_id=1

Returns list of all profile elements.

curl -X GET "https://apis.buzzboard.com/v4.0/profile/elements?prospect_id=1"
-H "Authorization: Bearer $ACCESS_TOKEN"
{
  "sections": [
    {
      "key": "keyword_analysis",
      "name": "Keyword Analysis",
      "description": "An analysis of the keywords used in the website to determine their rank.",
      "section_brief_desc": "Keyword Analysis lets you know whether your keyword(s) are showing results on search.",
      "grade": {
        "value": 100,
        "color": "#ff00ff"
      },
      "elements": [
        {
          "key": null,
          "name": "U.S. Department of Justice",
          "description": null,
          "data": {
            "google": "1",
            "yahoo": "1",
            "bing": "1"
          }
        }
      ]
    },
    {
      "key": "media",
      "name": "Advertising",
      "description": "How much does the business spend on various modes of advertising?",
      "section_brief_desc": "Paid Advertising statistics.",
      "grade": {
        "value": 100,
        "color": "#ff00ff"
      },
      "elements": [
        {
          "key": "dp_google_adword",
          "name": "Google AdWords",
          "description": "Google AdWords",
          "data": {
            "Presence": false,
            "Est. Ad Spend/mo": "-"
          }
        },
        {
          "key": "dp_bing_adword",
          "name": "Bing Ads",
          "description": "Bing Ads",
          "data": {
            "Presence": false,
            "Est. Ad Spend/mo": "-"
          }
        }
      ]
    }
  ],
  "meta": {
    "last_generated": 1492584540,
    "prospect_id": 1
  }
}

Profile - Grade

The grade object is used across all Elements APIs

Field Type Description
value

Number

Grade value that is calculated based on the elements in a particular section.

color

String

Returns the color code in hexadecimal format(such as "#0343ff").

Jobs

The Jobs API allows you to list the Details of the job.

PROPERTIES

The following properties are for use with the Jobs API.

Field Type Description
job_id

String

The unique identifier of the job.(e.g.) ?job_id=crP5khUAJYsOgiS5

ENDPOINTS

Jobs - Get Details v4.0

Retrieves the details of job.

https://apis.buzzboard.com/v4.0/jobs?job_id={id}&module_id={moduleName}

Parameters

Field Type Description
job_id Required

String

The unique identifier of the job.(e.g.) ?job_id=crP5khUAJYsOgiS5

module_id

String

The name of the module.(e.g.) ?module_id=createmany Possible module idscreatemany, search, searchmany Default value is createmany 

curl -X GET "https://apis.buzzboard.com/v4.0/jobs?job_id=crP5khUAJYsOgiS5&module_id=createmany" 
-H "Authorization: Bearer $ACCESS_TOKEN"
{
  "data": {
    "status": "Completed",
    "id": "crP5khUAJYsOgiS5",
    "created_at": 1492493949,
    "count": {
      "total": 2,
      "completed": 1,
      "inqueue": null,
      "failed": 1
    }
  }
}

Competition

The Competition API allows you to add, delete, convert to prospect, and other details of a competitor.

PROPERTIES

The following properties are for use with the Competition API.

Field Type Description
prospect_id

Number

The unique identifier of the prospect. (e.g.) https://apis.buzzboard.com/v4.0/competition?prospect_id=1
business_name

String

Name of the competitor.
website

String

Competitor's website. Required unless city and state fields are provided.
address

String

Competitor's Address information.For more information about address object see Address.
phone

String

Competitor's phone number.

ENDPOINTS

Competition - List v4.0

Retrieves all competitor's information available for the requested prospect.

https://apis.buzzboard.com/v4.0/competition

Parameters

Field Type Description
prospect_id Required

Number

The unique identifier of the prospect. (e.g.) https://apis.buzzboard.com/v4.0/competition?prospect_id=1

Returns all competitors available to the prospect with Id 1.

curl -X GET "https://apis.buzzboard.com/v4.0/competition?prospect_id=1"
-H "Authorization: Bearer $ACCESS_TOKEN"
-H "Content-Type: application/json"
{
  "data": [
    {
      "id": 2074304,
      "business_name": "Pantaloons",
      "website": "https://www.pantaloons.com",
      "phone": "(541) 754-3011",
      "address": {
        "line1": "115 Bulevard ville",
        "city": "Atlanta",
        "state": "GA",
        "zip": "12345",
        "country": "United States"
      },
      "score": {
        "value": "85",
        "color": "#03b377"
      },
      "created_at": 1492585472,
      "updated_at": 1492585472
    },
    {
      "id": 2074305,
      "business_name": "Toyotas",
      "website": "https://www.toyota.com",
      "phone": "(541) 754-3010",
      "address": {
        "line1": "115 lake ville",
        "city": "New York",
        "state": "NY",
        "zip": "12345",
        "country": "United States"
      },
      "score": {
        "value": "76",
        "color": "#f0b030"
      },
      "created_at": 1492585472,
      "updated_at": 1492585472
    }
  ],
  "meta": {
    "count": 2
  }
}

Competition - Add v4.0

Creates a new single or multiple competitor(s).

https://apis.buzzboard.com/v4.0/competition

Parameters

Field Type Description
prospect_id Required

Number

The unique identifier of the prospect. (e.g.) https://apis.buzzboard.com/v4.0/competition ?prospect_id=1

business_name Required

String

Name of the competitor.

website

String

Competitor's website. Required unless city and state fields are provided.

address Required

String

Competitor's Address information. For more information about the address object see Address.

phone

String

Competitor's phone number.

Add a new competitors to a prospect with Id 1.

curl -X POST "https://apis.buzzboard.com/v4.0/competition?prospect_id=1" 
-H "Authorization: Bearer $ACCESS_TOKEN" 
-H "Content-Type: application/json" 

-d '{
  "data": [
    {
      "business_name": "Pantaloons",
      "website": "https://www.pantaloons.com",
      "address": {
        "line1": "115 Bulevard ville",
        "city": "Atlanta",
        "zip": "12345",
        "state": "GA"
      },
      "phone": "(541) 754-3011"
    },
    {
      "business_name": "Toyotas",
      "website": "https://www.toyota.com",
      "address": {
        "line1": "115 lake ville",
        "city": "New York",
        "zip": "12345",
        "state": "NY",
        "country": "United States"
      },
      "phone": "(541) 754-3010"
    }
  ]
}' 
{
  "data": [
    {
      "id": 2074304,
      "business_name": "Pantaloonss",
      "website": "https://www.pantaloons.com",
      "phone": "(541) 754-3011",
      "address": {
        "line1": "115 Bulevard ville",
        "city": "Atlanta",
        "state": "GA",
        "zip": "12345",
        "country": "United States"
      },
      "score": {
        "value": "P",
        "color": "#f0b030"
      },
      "created_at": 1492585472,
      "updated_at": 1492585472,
      "meta": {
        "status": 201,
        "message": "Competitor added successfully"
      }
    },
    {
      "id": 2074305,
      "business_name": "Toyotas",
      "website": "https://www.toyota.com",
      "phone": "(541) 754-3010",
      "address": {
        "line1": "115 lake ville",
        "city": "New York",
        "state": "NY",
        "zip": "12345",
        "country": "United States"
      },
      "score": {
        "value": "P",
        "color": "#f0b030"
      },
      "created_at": 1492585472,
      "updated_at": 1492585472,
      "meta": {
        "status": 201,
        "message": "Competitor added successfully"
      }
    }
  ]
}

Competition - Delete v4.0

Deletes a single or multiple competitor's information. Once deleted, you won't be able to undo this action. If the Competitor Id does not exist, this request will return an error.

https://apis.buzzboard.com/v4.0/competition/deletecompetitors

Parameters

Field Type Description
competitor_id Required

Number

The unique identifier of the competitor.

prospect_id Required

Number

The unique identifier of the prospect.(e.g.) https://apis.buzzboard.com/v4.0/competition/deletecompetitors?prospect_id=1

Delete a competitor with Id 2074057 to the prospect with Id 1.

curl -X DELETE "https://apis.buzzboard.com/v4.0/competition/deletecompetitors?prospect_id=1"
-H "Authorization: Bearer $ACCESS_TOKEN"
-H "Content-Type: application/json" 
 
-d '{
  "data": [
    {
      "competitor_id": 2074057
    }
  ]
}'
"HTTP/1.1 204 No Content"

Competition - Convert v4.0

Converts the single or multiple competitor(s) to prospect(s).

https://apis.buzzboard.com/v4.0/competition/convert

Parameters

Field Type Description
competitor_id Required

Number

The unique identifier of the competitor.

prospect_id

Number

The unique identifier of the prospect.(e.g.) https://apis.buzzboard.com/v4.0/competition/convert?prospect_id=1

Convert the competitor to prospect

curl -X PUT "https://apis.buzzboard.com/v4.0/competition/convert?prospect_id=1"
-H "Authorization: Bearer $ACCESS_TOKEN"
-H "Content-Type: application/json" 
 
-d '{
  "data": [
    {
      "competitor_id": 2074077
    },
    {
      "competitor_id": 2074078
    }
  ]
}'
{
  "data": [
    {
      "id": 2074077,
      "business_name": "Harsha Toyota",
      "website": "https://www.harshatoyota.com",
      "phone": "(541) 754-3011",
      "address": {
        "line1": "115 Bulevard ville",
        "city": "Atlanta",
        "zip": "12345",
        "state": "GA",
        "country": "United States"
      },
      "score": {
        "value": 57,
        "color": "#f0b030"
      },
      "created_at": 1492585472,
      "updated_at": 1492585972,
      "meta": {
        "status": 200,
        "message": "Prospect added successfully"
      }
    },
    {
      "id": "2074078",
      "business_name": "Saboo Motors",
      "website": "https://www.saboomotors.com",
      "phone": "(541) 754-3010",
      "address": {
        "line1": "115 Bulevard ville",
        "city": "Atlanta",
        "zip": "12345",
        "state": "GA",
        "country": "United States"
      },
      "score": {
        "value": 67,
        "color": "#f0b030"
      },
      "created_at": 1492585772,
      "updated_at": 1492585872,
      "meta": {
        "status": 200,
        "message": "Prospect added successfully"
      }
    }
  ]
}

Responses

The BuzzBoard Ignite API uses standard HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx indicate an error with the provided information, and codes in the 5xx range indicate a server-side error. Contact your system administrator for additional information or for response codes not listed here.

Http status codes summary

Code Message Description
200 OK Everything worked as expected.
201 Created Everything worked as expected. Returned instead of 200 if your operation creates a new resource.
204 No Content Everything worked as expected. The response includes an empty body.
400 Bad Request Returned whenever the request is missing required information or is malformed in another way, e.g. the payload is malformed.
401 Unauthorized The API consumer credentials are invalid.
403 Forbidden The request has been refused because of insufficient user access privileges.
404 Not Found The requested resource could not be found.
405 Method Not Allowed The API consumer tried to access an endpoint with an invalid HTTP method, e.g. using PUT on a read-only resource.
408 Request Timeout Request Timeout.
429 Too Many Requests The rate limit was exceeded and access is temporarily blocked.
500 Internal Server Error Something went wrong on server side.
501 Not Implemented Not implemented.

Basic Structure

Parameters

Field Type Description
status

Number

The HTTP response code.
message

String

A message relating to the cause of the status.

 
{
  "error": {
    "status": 401,
    "message": "You are not authorized to request this service. Please contact support@buzzboard.com for further assistance."
  }
}
© 2024 BuzzBoard, Inc