Create Lead

Creates a new lead in SalesByte. This is typically used for lead generation or initial engagement activities.

Endpoint

POST /integrations/create_brandawareness

Purpose

To generate a lead quote with customizable customer details and initial settings.

Request Body

{
  "uuid": "string",
  "quote_profile_id": 0,
  "customer_name": "string",
  "customer_phone": "string | null",
  "customer_email": "string | null",
  "customer_company": "string | null",
  "chat_enabled": true,
  "send_type": "string",
  "type": "string",
  "workflows_enabled": true,
  "allow_customer_document_upload": true,
  "trigger_created_messages_to_customer": true,
  "salesperson_email": "string | array | null",
  "custom_field_1_content": "string | null",
  "custom_field_2_content": "string | null",
  "tag_1": "string | null",
  "tag_2": "string | null",
  "message": "string | null"
}

Parameters

Required Parameters

Parameter	Type	Description
`uuid`	string	Unique identifier for the integration configuration
`quote_profile_id`	integer	The ID of the quote profile to use
`customer_name`	string	The name of the customer
`chat_enabled`	boolean	Enable chat for the quote
`send_type`	string	Method for sending the brand awareness message (e.g., "email", "sms")
`type`	string	The specific type of brand awareness
`workflows_enabled`	boolean	Enable workflows for the quote
`allow_customer_document_upload`	boolean	Allow customer document uploads
`trigger_created_messages_to_customer`	boolean	Trigger initial messages to the customer

Optional Parameters

Parameter	Type	Description
`customer_phone`	string \| null	Customer's phone number (will be sanitized)
`customer_email`	string \| null	Customer's email address
`customer_company`	string \| null	Name of the customer's company
`salesperson_email`	string \| array \| null	Email(s) of the salesperson(s). If null, a random salesperson is assigned
`custom_field_1_content` - `custom_field_10_content`	string \| null	Content for custom fields 1-10
`tag_1` - `tag_10`	string \| null	Tags 1-10 for the quote
`message`	string \| null	A sales note message for the quote

Response

Success Response

Status Code: 200 OK

{
  "id": 123,
  "links": {
    "edit": "string",
    "customer_view": "string",
    "customer_verificate": "string",
    "customer_project_approval": "string"
  }
}

Response Fields

Field	Description
`id`	The ID of the newly created quote
`links.edit`	URL to edit the quote in SalesByte
`links.customer_view`	URL for the customer to view the quote
`links.customer_verificate`	URL for customer verification (if applicable)
`links.customer_project_approval`	URL for customer project approval (if applicable)

Error Responses

Status Code	Description
`404 Not Found`	Integration `uuid` or `quote_profile_id` not found, or salesperson with the specified email not found
`422 Unprocessable Entity`	Validation errors in the request body
`500 Internal Server Error`	An unexpected server error occurred

On this page