{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"cf244f1e-8313-4312-a826-c3a22248b829","name":"SalesByte API","description":"## SalesByte Integration API Documentation\n\nThis documentation provides details on the SalesByte API endpoints available for integrating external systems with your SalesByte instance. These endpoints allow for the creation of different types of quotes and the management of automation settings.\n\n## Endpoints\n\n### 1\\. Create Lead\n\nCreates a new lead in SalesByte. This is typically used for lead generation or initial engagement activities.\n\n- **URL:** `/integrations/create_brandawareness`\n    \n- **Method:** `POST`\n    \n- **Purpose:** To generate a lead quote with customizable customer details and initial settings.\n    \n\n**Request Body (JSON):**\n\n``` json\n{\n  \"uuid\": \"string\",         // Required: Unique identifier for the integration configuration.\n  \"quote_profile_id\": 0,    // Required: The ID of the quote profile to use.\n  \"customer_name\": \"string\", // Required: The name of the customer.\n  \"customer_phone\": \"string | null\", // Optional: Customer's phone number (will be sanitized).\n  \"customer_email\": \"string | null\", // Optional: Customer's email address.\n  \"customer_company\": \"string | null\", // Optional: Name of the customer's company.\n  \"chat_enabled\": true,     // Required: Enable chat for the quote (boolean).\n  \"send_type\": \"string\",    // Required: Method for sending the brand awareness message (e.g., \"email\", \"sms\").\n  \"type\": \"string\",         // Required: The specific type of brand awareness.\n  \"workflows_enabled\": true, // Required: Enable workflows for the quote (boolean).\n  \"allow_customer_document_upload\": true, // Required: Allow customer document uploads (boolean).\n  \"trigger_created_messages_to_customer\": true, // Required: Trigger initial messages to the customer (boolean).\n  \"salesperson_email\": \"string | array | null\", // Optional: Email(s) of the salesperson(s). Can be a single email or an array. If null, a random salesperson is assigned.\n  \"custom_field_1_content\": \"string | null\", // Optional: Content for custom field 1.\n  \"custom_field_2_content\": \"string | null\", // Optional: Content for custom field 2.\n  // ... up to custom_field_10_content\n  \"tag_1\": \"string | null\", // Optional: Tag 1 for the quote.\n  \"tag_2\": \"string | null\", // Optional: Tag 2 for the quote.\n  // ... up to tag_10\n  \"message\": \"string | null\" // Optional: A sales note message for the quote.\n}\n\n ```\n\n**Response (JSON):**\n\n``` json\n{\n  \"id\": 123, // The ID of the newly created quote.\n  \"links\": {\n    \"edit\": \"string\",             // URL to edit the quote in SalesByte.\n    \"customer_view\": \"string\",    // URL for the customer to view the quote.\n    \"customer_verificate\": \"string\", // URL for customer verification (if applicable).\n    \"customer_project_approval\": \"string\" // URL for customer project approval (if applicable).\n  }\n}\n\n ```\n\n- **Status Code:** `200 OK`\n    \n\n**Error Responses:**\n\n- `404 Not Found`: Integration `uuid` or `quote_profile_id` not found, or salesperson with the specified email not found.\n    \n- `422 Unprocessable Entity`: Validation errors in the request body.\n    \n- `500 Internal Server Error`: An unexpected server error occurred.\n    \n\n### 2\\. Create Standard Quote\n\nCreates a standard sales quote in SalesByte. Currently supports creating quotes with products based on the selected quote profile.\n\n- **URL:** `/integrations/create_quote`\n    \n- **Method:** `POST`\n    \n- **Purpose:** To generate a standard sales quote, potentially including products, based on a quote profile.\n    \n\n**Request Body (JSON):**\n\n``` json\n{\n  \"uuid\": \"string\",         // Required: Unique identifier for the integration configuration.\n  \"quote_profile_id\": 0,    // Required: The ID of the quote profile to use.\n  \"customer_name\": \"string\", // Required: The name of the customer.\n  \"customer_phone\": \"string | null\", // Optional: Customer's phone number (will be sanitized).\n  \"customer_email\": \"string | null\", // Optional: Customer's email address.\n  \"customer_company\": \"string | null\", // Optional: Name of the customer's company.\n  \"chat_enabled\": true,     // Required: Enable chat for the quote (boolean).\n  \"send_type\": \"string\",    // Required: Specifies how the quote should be sent.\n  \"workflows_enabled\": true, // Required: Enable workflows for the quote (boolean).\n  \"signable\": true,         // Required: Make the quote signable (boolean).\n  \"signable_until\": \"datetime | null\", // Optional: The datetime until which the quote is signable.\n  \"allow_customer_document_upload\": true, // Required: Allow customer document uploads (boolean).\n  \"trigger_created_messages_to_customer\": true, // Required: Trigger initial messages to the customer (boolean).\n  \"salesperson_email\": \"string | array | null\", // Optional: Email(s) of the salesperson(s). Can be a single email or an array. If null, a random salesperson is assigned.\n  \"alternative_1_bundle_id\": 0, // Optional: The ID of the product bundle for alternative 1. At least one alternative bundle ID is required.\n  \"alternative_1_title\": \"string | null\", // Optional: A custom title for alternative 1 (defaults to \"Paket 1\" if not provided).\n  \"alternative_2_bundle_id\": 0, // Optional: The ID of the product bundle for alternative 2.\n  \"alternative_2_title\": \"string | null\", // Optional: A custom title for alternative 2 (defaults to \"Paket 2\" if not provided).\n  \"alternative_3_bundle_id\": 0, // Optional: The ID of the product bundle for alternative 3.\n  \"alternative_3_title\": \"string | null\", // Optional: A custom title for alternative 3 (defaults to \"Paket 3\" if not provided).\n  \"custom_field_1_content\": \"string | null\", // Optional: Content for custom field 1.\n  \"custom_field_2_content\": \"string | null\", // Optional: Content for custom field 2.\n  // ... up to custom_field_10_content\n  \"tag_1\": \"string | null\", // Optional: Tag 1 for the quote.\n  \"tag_2\": \"string | null\", // Optional: Tag 2 for the quote.\n  // ... up to tag_10\n  \"message\": \"string | null\" // Optional: A sales note message for the quote.\n}\n\n ```\n\n- **Note:** At least one of `alternative_1_bundle_id`, `alternative_2_bundle_id`, or `alternative_3_bundle_id` must be provided. The provided `bundle_id` must correspond to a product bundle that the company associated with the `quote_profile_id` has access to.\n    \n\n**Response (JSON):**\n\n``` json\n{\n  \"id\": 123, // The ID of the newly created quote.\n  \"links\": {\n    \"edit\": \"string\",             // URL to edit the quote in SalesByte.\n    \"customer_view\": \"string\",    // URL for the customer to view the quote.\n    \"customer_verificate\": \"string\", // URL for customer verification (if applicable).\n    \"customer_project_approval\": \"string\" // URL for customer project approval (if applicable).\n  }\n}\n\n ```\n\n**Error Responses:**\n\n- `400 Bad Request`: Quote creation via API is not supported for the selected `quote_profile->quote_type`.\n    \n- `404 Not Found`: Integration `uuid` or `quote_profile_id` not found.\n    \n- `422 Unprocessable Entity`: Validation errors in the request body.\n    \n- `500 Internal Server Error`: An unexpected server error occurred.\n    \n\n### 3\\. Create Quote Using Template\n\nCreates a new quote by cloning an existing quote template. Allows for overriding basic customer details and custom fields.\n\n- **URL:** `/integrations/create_quote/template`\n    \n- **Method:** `POST`\n    \n- **Purpose:** To quickly generate a new quote based on a predefined template, customizing customer-specific information.\n    \n\n**Request Body (JSON):**\n\n``` json\n{\n  \"uuid\": \"string\",         // Required: Unique identifier for the integration configuration (template-specific).\n  \"quote_template_id\": 0,    // Required: The ID of the quote template to use.\n  \"customer_name\": \"string\", // Required: The name of the customer for the new quote.\n  \"customer_email\": \"string | null\", // Required if customer_phone is null. Customer's email address (must be valid format if provided).\n  \"customer_phone\": \"string | null\", // Required if customer_email is null. Customer's phone number (validated format).\n  \"customer_fields\": {      // Optional: An array or object containing data to update custom fields.\n      // Structure depends on the custom fields defined in the template.\n  },\n  \"trigger_created_messages_to_customer\": true // Required: Trigger initial messages to the customer (boolean).\n}\n\n ```\n\n**Response:**\n\n- **Body:** `Quote created` (plain text)\n    \n- **Status Code:** `200 OK`\n    \n\n**Error Responses:**\n\n- `404 Not Found`: Integration `uuid` not found, or `quote_template_id` not found or not associated with the integration.\n    \n- `422 Unprocessable Entity`: Validation errors in the request body (missing required fields, invalid email/phone format).\n    \n- `500 Internal Server Error`: An unexpected server error occurred.\n    \n\n## Outgoing Webhook: Quote Checkout\n\nThis webhook is triggered by SalesByte whenever a quote is successfully checked out by a customer (signed or purchased). SalesByte will send a `POST` request containing detailed information about the checked-out quote to the configured webhook URL in your external system.\n\n- **URL:** (Configured by the user in SalesByte's integration settings)\n    \n- **Method:** `POST`\n    \n- **Purpose:** To notify an external system in real-time when a SalesByte quote has been finalized by the customer.\n    \n\n**Request Body (JSON):**\n\nSalesByte will send a JSON object in the request body containing detailed information about the checked-out quote.\n\n``` json\n{\n  \"id\": 0,                    // The unique ID of the quote.\n  \"quote_profile_name\": \"string\", // The name of the quote profile used for this quote.\n  \"customer_name\": \"string\",  // The full name of the customer.\n  \"customer_first_name\": \"string | null\", // The first name of the customer.\n  \"customer_last_name\": \"string | null\",  // The last name of the customer.\n  \"customer_company\": \"string | null\", // The name of the customer's company.\n  \"customer_phone\": \"string | null\", // The customer's phone number.\n  \"customer_email\": \"string | null\", // The customer's email address.\n  \"address_firstline\": \"string | null\", // The first line of the verified address (if available).\n  \"address_secondline\": \"string | null\", // The second line of the verified address (if available).\n  \"address_postcode\": \"string | null\", // The postcode of the verified address (if available).\n  \"address_city\": \"string | null\", // The city of the verified address (if available).\n  \"custom_fields\": {          // Object containing data from custom fields, mapped by label.\n    \"Custom Field Label 1\": \"value\",\n    \"Custom Field Label 2\": \"value\",\n    // ... up to 10 custom fields that are not disabled\n  },\n  \"quote_value\": \"numeric | null\", // The total value of the quote.\n  \"created_at\": \"string\",     // The timestamp when the quote was created (ISO 8601 format).\n  \"updated_at\": \"string\",     // The timestamp when the quote was last updated (ISO 8601 format).\n  \"salesperson\": {\n    \"name\": \"string\",         // The name of the assigned salesperson.\n    \"email\": \"string\"         // The email of the assigned salesperson.\n  },\n  \"is_signed\": true,          // Boolean indicating if the quote has at least one signature.\n  \"is_fully_signed\": true,    // Boolean indicating if all required signatures have been collected.\n  \"requires_more_signatures\": true, // Boolean indicating if more signatures are still needed.\n  \"is_project_approval_pending\": true, // Boolean indicating if project approval is pending.\n  \"is_project_approval_signed\": true,  // Boolean indicating if project approval has been signed.\n  \"signed_offer\": {           // Details of the signed quote option (if applicable).\n    \"main_document_name\": \"string\", // Name of the main document.\n    \"main_document_url\": \"string\", // URL to the main signed document PDF.\n    \"extra_documents\": [      // Array of additional documents included in the signed offer.\n      {\n        \"name\": \"string\",     // Name of the document.\n        \"pdf_url\": \"string\"   // URL to the document PDF.\n      }\n      // ... more extra documents\n    ]\n  } | null,\n  \"signed_products\": {        // Details of signed products if the quote is product-based (if applicable).\n    \"original_price_including_vat\": \"numeric\", // Original total price including VAT.\n    \"price_including_vat\": \"numeric\",     // Final total price including VAT.\n    \"discount_including_vat\": \"numeric\",  // Total discount including VAT.\n    \"currency\": \"string\",                 // Currency of the product prices.\n    \"products\": [                 // Array of signed product details.\n      {\n        \"sku\": \"string | null\", // Product SKU.\n        \"amount\": \"numeric\",    // Amount of the product.\n        \"url\": \"string | null\", // URL related to the product.\n        \"name\": \"string\",       // Product name.\n        \"original_price_including_vat\": \"numeric\", // Original price including VAT per unit.\n        \"price_including_vat\": \"numeric\",     // Final price including VAT per unit.\n        \"original_sum_including_vat\": \"numeric\", // Original total sum including VAT for the amount.\n        \"sum_including_vat\": \"numeric\",      // Final total sum including VAT for the amount.\n        \"currency\": \"string\",                // Currency of the product.\n        \"price_unit\": \"string | null\"     // Price unit (e.g., \"pcs\").\n      }\n      // ... more signed products\n    ]\n  } | null,\n  \"additional_documents_signed\": [ // Array of additional documents that have been signed.\n    {\n      \"name\": \"string\",           // Name of the document.\n      \"url\": \"string\"             // URL to the signed document PDF.\n    }\n    // ... more signed documents\n  ],\n  \"additional_documents_requiring_signature\": [ // Array of additional documents that still require signatures.\n    {\n      \"name\": \"string\",           // Name of the document.\n      \"url\": \"string\"             // URL to the document PDF.\n    }\n    // ... more documents requiring signatures\n  ],\n  \"statuses\": [                 // Array of statuses associated with the quote.\n    \"string\"\n    // ... more statuses\n  ],\n  \"links\": {                    // Relevant URLs for the quote within SalesByte.\n    \"edit\": \"string\",             // URL to edit the quote.\n    \"customer_view\": \"string\",    // URL for the customer to view the quote.\n    \"customer_verificate\": \"string\", // URL for customer verification (if applicable).\n    \"customer_project_approval\": \"string\" // URL for customer project approval (if applicable).\n  }\n}\n\n ```\n\n**Expected Response from External System:**\n\nUpon receiving the webhook request, your external system should respond with an HTTP status code of `200 OK` to acknowledge successful receipt of the data. Any other status code (e.g., `400`, `500`) will indicate to SalesByte that the delivery failed, and SalesByte may attempt to retry the webhook delivery according to its internal retry policy. The response body is typically ignored by SalesByte.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"37762253","team":19074714,"collectionId":"cf244f1e-8313-4312-a826-c3a22248b829","publishedId":"2sB2qgcxrx","public":true,"publicUrl":"https://documenter-api.postman.tech/view/37762253/2sB2qgcxrx","privateUrl":"https://go.postman.co/documentation/37762253-cf244f1e-8313-4312-a826-c3a22248b829","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.12.0","publishDate":"2025-05-30T15:46:45.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/b215c641e0a90582a4d1e38938f279089e06f3ef0891ffae056165c92cde9a5d","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2sB2qgcxrx"}