Integration API
The Integration API provides write access to create quotes and leads at the profile level. Authentication is done via a UUID included in the request body.
Key Characteristics
| Aspect | Details |
|---|---|
| Authentication | UUID in request body |
| Scope | Profile-level |
| Operations | Write (POST) |
| Base URL | /integrations/* |
For read operations (retrieving quotes), see the Quotes API which uses Bearer token authentication at the company level.
Available Endpoints
Create Lead
Generate lead quotes for lead generation or initial engagement activities
Create Quote
Create sales quotes with products, alternatives, and custom fields
Create Quote from Template
Quickly generate quotes based on predefined templates
Endpoints Overview
| Method | Endpoint | Description |
|---|---|---|
| POST | /integrations/create_brandawareness | Create a new lead |
| POST | /integrations/create_quote | Create a standard quote |
| POST | /integrations/create_quote/template | Create a quote from template |
Authentication
All Integration API requests require a uuid parameter in the request body:
{
"uuid": "your-integration-uuid",
// ... other parameters
}The UUID is unique to each integration configuration and acts as the authentication key for the request. It is obtained from your integration settings in SalesByte.
Keep your integration UUID secure. Anyone with access to the UUID can create quotes on the associated profile.
Common Parameters
All endpoints share these common parameters:
| Parameter | Type | Description |
|---|---|---|
uuid | string | Required. Unique identifier for the integration configuration |
quote_profile_id | integer | Required. The quote profile to use |
customer_name | string | Required. The name of the customer |
customer_email | string | null | Customer's email address |
customer_phone | string | null | Customer's phone number |
Response Format
Successful creation responses return:
{
"id": 123,
"links": {
"edit": "https://app.salesbyte.se/offerter/123/redigera",
"customer_view": "https://app.salesbyte.se/view/abc123",
"customer_verificate": "https://app.salesbyte.se/signed/abc123",
"customer_project_approval": "https://app.salesbyte.se/view/abc123?project_approval=1"
}
}| Field | Description |
|---|---|
id | Internal identifier of the 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 |
links.customer_project_approval | URL for customer project approval |