Create CRM Opportunity Endpoint Documentation

Introduction

The /create_crm_opportunity/<api_key> endpoint allows you to create a Customer Relationship Management (CRM) opportunity by providing relevant information. This endpoint is accessible through a POST request and requires the use of a valid <api_key> for authentication purposes. Backd will provide the applicable API Key to Affiliate Partners.

Endpoint URL

https://xxx.tasksuite.com/webhook/json/create_crm_opportunity/<api_key>

Authentication

To access this endpoint, you need to include the <api_key> as part of the URL. The <api_key> serves as an authentication mechanism to ensure only authorized users can create CRM opportunities.

Request Method

POST

Request Body

The request body must be a JSON object with the following fields:

Field	Sub-field	Description	Format	Required	Recommended

Field	Sub-field	Description	Format	Required	Recommended
AnnualRevenue		The annual revenue of the company associated with the opportunity.	Integer		X
BirthDay		The birthdate of the contact person in the format "YYYY-MM-DD".	String		X
BusinessAddress		The address details of the business.	Object		X
	Address	The street address of the business.	String		X
	Address2	Additional address details (e.g., suite number).	String		X
	City	The city of the business address.	String		X
	State	The state or province of the business address.	String		X
	Zip	The ZIP or postal code of the business address.	String		X
BusinessType		The type of business (e.g., LLC, Corporation, etc.).	String		X
Company		The name of the company associated with the opportunity.	String	X
ContactEmail		The email address of the contact person.	String	X
ContactFirstName		The first name of the contact person.	String	X
ContactLastName		The last name of the contact person.	String	X
ContactPhone		The phone number of the contact person.	String	X
CreditScore		The credit score of the opportunity (e.g., "Poor (639 or less)").	String		X
FoundedMonth		The month in which the company was founded.	String		X
FoundedYear		The year in which the company was founded.	String		X
HomeAddress		The address details of the contact person's home.	Object		X
	Address	The street address of the contact.	String		X
	Address2	Additional address details (e.g., suite number).	String		X
	City	The city of the contact address.	String		X
	State	The state or province of the contact address.	String		X
	Zip	The ZIP or postal code of the contact address.	String		X
OwnershipPct		The percentage of ownership of the opportunity in the company.	Integer		X
LoanAmount		The desired amount of capital associated with the opportunity.	Integer		X
LoanReason		The reason for requesting capital associated with the opportunity.	String		X
Ssn		The Social Security Number of the contact person.	String	X
TaxId		The Tax ID of the company associated with the opportunity.	String	X
TimeInBusinessMonths		The number of months the company has been in business.	Integer		X
ID		Unique identifier for the opportunity.	String	X
CampaignID		Unique identifier for the campaign associated with the opportunity.	String		X
ReferredBy		The affiliate partner name.	String	X
Files		Filenames and data of files related to the opportunity (e.g., bank statements, documents).	Array of objects	X
	Name	Filename with file format.	String	X
	Data	The raw data of the file.	String (Base64 encoded file content)	X

Response

The response will indicate the success or failure of the CRM opportunity creation request. The details of the response may vary based on the implementation of the API. A typical response might be a JSON object containing a success message or an error message.

Example Request

POST <https://xxx.tasksuite.com/webhook/json/create_crm_opportunity/<api_key>>
Content-Type: application/json

{
   "AnnualRevenue": 120000,
   "BirthDay": "1990-12-15",
   "BusinessAddress": {
      "Address": "123 Main Street",
      "Address2": "Suite 200",
      "City": "Anytown",
      "State": "CA",
      "Zip": "90210"
   },
   "BusinessType": "corporation",
   "Company": "ABC Tech Solutions",
   "ContactEmail": "john.doe@example.com",
   "ContactFirstName": "John",
   "ContactLastName": "Doe",
   "ContactPhone": "555-123-4567",
   "CreditScore": "Excellent (800+)",
   "FoundedMonth": "January",
   "FoundedYear": "2015",
   "HomeAddress": {
      "Address": "456 Oak Avenue",
      "Address2": "Unit 10",
      "City": "Anytown",
      "State": "CA",
      "Zip": "90210"
   },
   "Industry": "technology",
   "LoanAmount": 50000,
   "LoanReason": "expansion",
   "OwnershipPct": 100,
   "Ssn": "123456789",
   "TaxId": "987654321",
   "TimeInBusinessMonths": 72,
   "ID": "example-opportunity-id",
   "CampaignID": "example-campaign-id",
   "ReferredBy": "Affiliate Partner Name",
   "Price": 1,
   "Files": [
      {
         "Name": "bankstatement_1.pdf",
         "Data": "JVBERi0xLjMKJcTl8uXrp/Og0MTGCjQgMCBvYmoKPDwgL0xlbmd0aCA1IDAgUiAvRmlsdGVyIC9GbGF0ZURlY29..."
      },
      {
         "Name": "bankstatement_2.pdf",
         "Data": "UEsDBBQAAAAIAGWOOU/Wh7XIAgAAAAwAAAJAAAAL..."
      },
      {
         "Name": "bankstatement_3.pdf",
         "Data": "UEsDBBQBBBBIBGWOOU/Wh7XIBgBBBBwBBBJBBBBL..."
      }
      
   ]
}

Example Response (Success)

{
    "status_code": 200,
    "status": "OK",
    "error": false,
    "id": 445971
}

Example Response (Failure)

Error Handling

In case of errors, the response will contain an appropriate error message with details on what caused the error. Make sure to handle these errors.

Notes

Ensure that the required fields are provided in the request body; otherwise, the API will return an error indicating the missing fields.
The <api_key> in the URL must be valid and active for the CRM opportunity creation to be successful.
For files in the Files array, make sure to use secure and valid URLs for proper processing and attachment to the CRM opportunity.