Using the Opportunity API

Created by Jared Hislop, Modified on Thu, 29 Aug at 12:05 PM by Jared Hislop

Parameter	Type	Required	Description
api_key	string	Yes	The API key to authenticate the request
salesperson_id	integer	No	The ID of the user to associate with the opportunity
due_at	string	No	The Due Date of the Opportunity. Must be in format YYYY/MM/DD
source	string	No	The Source of the Opportunity. See Table below for possible choices.
company_name	string	No	The name of the company. If the company doesn’t exists it will be created
first_name	string	Yes	The first name of the contact
last_name	string	Yes	The last name of the contact
phone	string	Yes	The phone number of the contact
email	Email	Yes	The email address of the contact
address_line_1	string	Yes	The first line of the contact's address
address_city	string	Yes	The city of the contact's address
address_state	string	Yes	The state of the contact's address
address_zip	string	Yes	The ZIP code of the contact's address
address_country	string	Yes	The country of the contact's address
notes	string	No	Additional notes or comments about the opportunity

API Base URL: https://api.bitumio.com/api/opportunities/create

Method 1: POST via JSON

Request Parameters

Content-Type: application/json

Request Body Example

{
"api_key": "<Your API Key Here>",
"source":"EXPO_LEAD",
"salesperson_id":"123",
"due_at":"2024/08/29",
"company_name": "Big A",
"first_name": "John",
"last_name": "Doe",
"phone": "555-1234",
"email": "[email protected]",
"address_line_1": "123 Main St",
"address_city": "Springfield",
"address_state": "IL",
"address_zip": "62704",
"address_country": "USA",
"notes": "Interested in new product line."
}

Method 2: GET using Query String Parameters

Request Example

https://api.bitumio.com/api/opportunities/create?api_key=your_api_key_here&salesperson_id=12345&company_name=ABC%20 Corp&first_name=John&last_name=Doe&phone=555- 1234&[email protected]&address_line_1=123%20Main%20St&address_city=Springfiel
d&address_state=IL&address_zip=62704&address_country=USA&notes=Interested%20in%20new%2 0product%20line

NOTE: The character limit on a GET request is 2,048 characters. So if you have long messages the request could fail to create the opportunity.

Response

Success: Returns a success message along with the created opportunity's details.
Error: Returns an error message detailing what went wrong (e.g., missing required parameters, invalid data format).

Possible Values for "source" field

ONLINE
WEBSITE_LEAD
EXPO_LEAD
SOCIAL_MEDIA
WEBSITE_REQUEST
INTERNAL_SALES
CHANNEL_SALES
EXTERNAL_SALES
EXISTING_RELATIONSHIP
REPEAT_CUSTOMER
ADVERTISEMENTS
TRADE_SHOWS
REFERRAL
OTHER