Karbot API is a REST interface that provides access to key services for the Karbot platform. Its main functionality focuses on sending messages through WhatsApp.
\nHere is a more technical overview of how to use our services, including Authentication, Fetch Line, Fetch Templates, Send Template Message, and Send Session Message.
\nWebhooks handle incoming messages from users responding on WhatsApp, serving as a critical channel for delivering timely notifications and managing errors.
\nWhen a customer sends a message or responds to templates on WhatsApp, Karbot immediately generates a notification through an HTTP POST request to the webhook previously configured for the corresponding line.
\nTo enable automatic reception of customer responses, it is necessary to configure the webhook in the Karbot platform from the business line details section. It is recommended to contact an administrator to complete this configuration.
\nNote: The configured webhook must return an HTTP_SUCCESS code (code: 2xx) along with an empty response. If this is not done within 10 seconds, the notification will be considered a failure, and the webhook cannot be set up.
\nExample of a received text message:
\n{\n \"app\": \"LineName\",\n \"timestamp\": 1702489054213,\n \"version\": 2,\n \"type\": \"message\",\n \"payload\": {\n \"id\": \"ABGHUhMkEBMXDwIKOiGSN8IQ58Kc4w\",\n \"source\": \"5211234567891\",\n \"type\": \"text\",\n \"payload\": {\n \"text\": \"hi\"\n },\n \"sender\": {\n \"phone\": \"5211234567891\",\n \"name\": \"client name\",\n \"country_code\": \"52\",\n \"dial_code\": \"11234567891\"\n }\n }\n}\n\nExample Request when a quick reply is pressed:
\n{\n \"app\": \"LineName\",\n \"timestamp\": 1702533767736,\n \"version\": 2,\n \"type\": \"message\",\n \"payload\": {\n \"id\": \"ABGHUhMzgIVDbwIKOoGepkzTRjELjA\",\n \"source\": \"5211234567891\",\n \"type\": \"quick_reply\",\n \"payload\": {\n \"text\": \"Contact\",\n \"type\": \"button\"\n },\n \"sender\": {\n \"phone\": \"5211234567891\",\n \"name\": \"client name\",\n \"country_code\": \"52\",\n \"dial_code\": \"11234567891\"\n },\n \"context\": {\n \"id\": \"bd6fd4da-a2e4-4098-87ca-88f9c81f2dc5\",\n \"gsId\": \"3dfd76c4-2ac5-4435-99db-be9a412d0e5a\",\n \"forwarded\": false,\n \"frequently_forwarded\": false\n }\n }\n}\n\nDescription:
\nThis endpoint allows users to authenticate using a valid username and password. It returns an access token for subsequent requests.
\nUsers must authenticate with a web service role to use the API.
\nThe generated token has an expiration period of 10 days from the time of creation. After 10 days, the token will no longer be valid, and the user will need to log in again to obtain a new token.
\nIt is recommended to renew the token by logging in again every 9 days to ensure uninterrupted access to protected resources.
\nRequest Body:
\nemail: This is the email address of the user with the web service role.
\npassword: Password of the user with the web service role.
\nDescription:
\nThis endpoint allows you to retrieve information about the configured line for using the API. The returned information depends on the authorization token provided.
\nRequest Parameters:
\nNo additional parameters are required beyond the authorization token provided in the headers.
\n","urlObject":{"protocol":"https","path":["v1","lines",""],"host":["api","karbot","mx"],"query":[],"variable":[]}},"response":[{"id":"adc657c2-8d45-4b58-a7ee-ae9b64a1bc18","name":"Success","originalRequest":{"method":"GET","header":[],"url":"https://api.karbot.mx/v1/lines/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"OK\",\n \"statusCode\": 200,\n \"description\": \"La información de la linea se obtuvo con éxito.\",\n \"outPut\": {\n \"businessId\": 10,\n \"lineId\": 26,\n \"appName\": \"PruebasKarbot\",\n \"phoneNumber\": \"13341864797\",\n \"useForLine\": \"Omnichannel-Outbound\",\n \"additionalBalance\": 0,\n \"bidirectional\": true,\n \"currentBalance\": 689,\n \"webhook\": \"\",\n \"webhookIsActive\": true\n }\n}"},{"id":"1a66830f-d54d-4455-b76d-d1c6bbb029d4","name":"Failed","originalRequest":{"method":"GET","header":[],"url":"https://api.karbot.mx/v1/lines/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Bad Request\",\n \"statusCode\": 400,\n \"description\": \"No se encontró línea configurada. Por favor, asegúrate de configurar una línea y volver a iniciar sesión.\",\n \"outPut\": null\n}"},{"id":"eff3a1d5-85f1-443a-a450-3ca26183a95e","name":"Unauthorized","originalRequest":{"method":"GET","header":[],"url":"https://api.karbot.mx/v1/lines/"},"status":"Unauthorized","code":401,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"Unauthorized"}],"_postman_id":"30b4231f-57a7-4945-bd76-e1ef9c3841bc"}],"id":"8163db83-eb8f-407f-a193-45657a80ab43","_postman_id":"8163db83-eb8f-407f-a193-45657a80ab43","description":""},{"name":"Templates","item":[{"name":"Templates","id":"5aa2388c-7bfb-4f24-8014-7ed58edbd7cc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Description:
\nThis endpoint allows you to retrieve information about the templates configured on a specific line. The returned information depends on the authorization token provided.
\nRequest Parameters:
\nNo additional parameters are required beyond the authorization token provided in the headers.
\n","urlObject":{"protocol":"https","path":["v1","templates",""],"host":["api","karbot","mx"],"query":[],"variable":[]}},"response":[{"id":"1cf3a10f-f5d0-4860-85d7-ab5a8dbb34f1","name":"Success","originalRequest":{"method":"GET","header":[],"url":"https://api.karbot.mx/v1/templates/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"OK\",\n \"statusCode\": 200,\n \"description\": \"La información de las plantillas se obtuvo con éxito.\",\n \"outPut\": [\n {\n \"id\": 130,\n \"templateId\": \"f683de2e-1824-4f78-8776-6ff0496b7bd1\",\n \"templateName\": \"Saldo 1816\",\n \"status\": \"APPROVED\",\n \"templateCategory\": \"UTILITY\",\n \"numberVariables\": 0,\n \"example\": \"hola, favor de pagar saldop pendiente\",\n \"buttons\": \"{}\",\n \"createdAt\": \"2023-07-11T00:15:58.794Z\"\n },\n {\n \"id\": 129,\n \"templateId\": \"66832765-5b5b-4c9f-9d51-a28947a4800e\",\n \"templateName\": \"saludo a cliente 2\",\n \"status\": \"APPROVED\",\n \"templateCategory\": \"MARKETING\",\n \"numberVariables\": 0,\n \"example\": \"Hola Cliente amigo\",\n \"buttons\": \"{}\",\n \"createdAt\": \"2023-06-27T17:37:16.842Z\"\n },\n ]\n}"},{"id":"15635ea3-3c4c-4a16-b181-3e316623df6c","name":"Failed","originalRequest":{"method":"GET","header":[],"url":"https://api.karbot.mx/v1/templates/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Bad Request\",\n \"statusCode\": 400,\n \"description\": \"No se encontraron plantillas para línea configurada.\",\n \"outPut\": null\n}"},{"id":"7c95f509-ad61-4022-9e9a-974b19a462ff","name":"Unauthorized","originalRequest":{"method":"GET","header":[],"url":"https://api.karbot.mx/v1/templates/"},"status":"Unauthorized","code":401,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"Unauthorized"}],"_postman_id":"5aa2388c-7bfb-4f24-8014-7ed58edbd7cc"},{"name":"Template","id":"965588ce-ee1b-44e1-bd21-29a95a6e0889","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Description:
\nThis endpoint Retrieves sending statistics for a specific message template. The returned information depends on the authorization token provided.
\n","urlObject":{"protocol":"https","path":["v1","templates",":templateId",""],"host":["api","karbot","mx"],"query":[{"description":{"content":"Optional. The start date from which to retrieve statistics. Must be in ISO 8601 format (YYYY-MM-DD). If not provided, data from the last 14 days will be used by default.
\n","type":"text/plain"},"key":"firstDate","value":"2025-05-20"},{"description":{"content":"Optional. The end date up to which to retrieve statistics. Must be in ISO 8601 format (YYYY-MM-DD). If not provided, today’s date will be used by default.
\n","type":"text/plain"},"key":"endDate","value":"2025-05-30"}],"variable":[{"description":{"content":"Required. This field indicates the ID of the template to retrieve statistics for.
\n","type":"text/plain"},"type":"any","value":"d62eca79-44e1-417c-a63d-a37e23b4560b","key":"templateId"}]}},"response":[{"id":"44606c7f-8e44-4052-9434-51deb1c871e0","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.karbot.mx/v1/templates/d62eca79-44e1-417c-a63d-a37e23b4560b/?firstDate=2025-05-20&endDate=2025-05-30","protocol":"https","host":["api","karbot","mx"],"path":["v1","templates","d62eca79-44e1-417c-a63d-a37e23b4560b",""],"query":[{"key":"firstDate","value":"2025-05-20"},{"key":"endDate","value":"2025-05-30"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"OK\",\n \"statusCode\": 200,\n \"description\": \"La información de la plantilla se obtuvo con éxito.\",\n \"outPut\": {\n \"id\": 200,\n \"templateId\": \"d62eca79-44e1-417c-a63d-a37e23b4560b\",\n \"templateName\": \"paquetes karbot 1348\",\n \"templateCategory\": \"MARKETING\",\n \"templateType\": \"DOCUMENT\",\n \"example\": \"Hola estos son los paquetes\",\n \"createdAt\": \"2023-07-11T00:15:58.794Z\",\n \"templateStats\": [\n {\n \"templateStatus\": \"total\",\n \"countStatus\": 13\n },\n {\n \"templateStatus\": \"scope\",\n \"countStatus\": 10\n },\n {\n \"templateStatus\": \"interaction\",\n \"countStatus\": 8\n },\n {\n \"templateStatus\": \"invalid numbers\",\n \"countStatus\": 3\n },\n {\n \"templateStatus\": \"rate\",\n \"countStatus\": \"80.00\"\n }\n ]\n }\n}"},{"id":"627817c4-c6c0-466d-8e10-a9d2f1962622","name":"Failed","originalRequest":{"method":"GET","header":[],"url":"https://api.karbot.mx/v1/templates/d62eca79-44e1-417c-a63d-1234"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Bad Request\",\n \"statusCode\": 400,\n \"description\": \"No se encontraron plantillas para línea configurada.\",\n \"outPut\": null\n}"},{"id":"303e6356-8da0-44c3-9d3f-a8f2b5243ef7","name":"Unauthorized","originalRequest":{"method":"GET","header":[],"url":"https://api.karbot.mx/v1/templates/d62eca79-44e1-417c-a63d-1234"},"status":"Unauthorized","code":401,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"Unauthorized"}],"_postman_id":"965588ce-ee1b-44e1-bd21-29a95a6e0889"}],"id":"d9ed37a5-0c10-45c2-8271-42e4fb0fefac","_postman_id":"d9ed37a5-0c10-45c2-8271-42e4fb0fefac","description":""},{"name":"Messages","item":[{"name":"Send Template Message","id":"a3baa9ae-e242-4902-87a8-99d7a38503b4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Description:
\nThis endpoint allows users to send messages based on a predefined template. When a request is made via a template message, an outbound lead is created based on the selected template (Advisor Assignment).
\nRequest Body:
\ncountryCode (optional): This field represents the country code to which the message will be sent. This field is optional. If not provided, the default country code of Mexico will be used.
\nto: Specifies the phone number of the recipient to whom the message will be sent.
\ntemplateName / templateId: You can provide either the templateName or the templateId to identify the template to be used. It is not required to send both; the request is valid if only one of the two is provided.
\nvariables: This field contains a list of variables that will be used in the message template. These variables are placeholders within the template that will be filled with specific information before sending the message.
\nfileUrl (optional): The URL of the image or document file to be included in the message. This parameter is required when the selected template includes an image or document component. The file must be publicly accessible via the provided URL.
\nDescription:
\nThis endpoint allows users to sends multiple messages using a specified message template. When a request is made through this endpoint, each message triggers the creation of an outbound lead based on the selected template (Advisor Assignment). This allows for mass communication while automatically associating each recipient with a lead and advisor.
\nRequest Body:
\ntemplateName / templateId: You can provide either the templateName or the templateId to identify the template to be used. It is not required to send both; the request is valid if only one of the two is provided.
\nmessages: An array of objects, where each object represents an individual message to be sent using the selected template. Each object must include the necessary data required to send a message, such as the recipient’s phone number and any dynamic template parameters.
\ncountryCode (optional): This field represents the country code to which the message will be sent. This field is optional. If not provided, the default country code of Mexico will be used.
\nto: Specifies the phone number of the recipient to whom the message will be sent.
\nvariables: This field contains a list of variables that will be used in the message template. These variables are placeholders within the template that will be filled with specific information before sending the message.
\nfileUrl: The URL of the image or document file to be included in the message. This parameter is required when the selected template includes an image or document component. The file must be publicly accessible via the provided URL.
\nDescription:
\nThis endpoint allows users to send a session message. Session messages can only be sent within 24 hours after the last message sent by the user. If you try to send a message outside of this 24-hour window, you will receive an error event in your webhook.
\nRequest Body:
\ncountryCode (optional): The country code of the recipient’s phone number. This field is optional, and if not provided, the default country code for Mexico will be used.
\nto: The phone number of the recipient to whom the message will be sent.
\ntype: This field indicates the type of session message.
\nmessage: The content of the message to be sent.
\nDescription:
\nThis endpoint allows the creation of inbound leads and automatically assigns the lead to an available advisor based on the specified category. The system ensures that the lead is categorized correctly and routed to the appropriate advisor for personalized follow-up. It supports various lead sources such as websites, social media platforms, or other digital channels.
\nRequest Body:
\ncanal: The source channel where the lead was generated (e.g., website, facebook).
\norigin: The origin of the lead, such as the platform or campaign (e.g., “Mercado Libre,” “Formulario”).
\ncategory: The category to which the lead belongs (e.g., “used car”).
\nphoneNumber: The phone number of the lead.
\nname (optional): The full name of the lead.
\nemail (optional): The email address of the lead.
\ncampaign (optional): The name of the campaign associated with the lead.
\nreferenceId (optional): A unique identifier for the lead.
\ngeneralData (optional): A nested object containing additional details about the lead, such as distributor, brand, model, year, and message.
\nEndpoint to retrieve inbound leads filtered by different criteria. Allows querying incoming leads using search parameters such as customer phone number and date range.
\n","urlObject":{"protocol":"https","path":["v1","leads","inbound",""],"host":["api","karbot","mx"],"query":[{"disabled":true,"description":{"content":"Optional. Customer’s phone number.
\n","type":"text/plain"},"key":"customerPhoneNumber","value":"3312345678"},{"disabled":true,"description":{"content":"Optional. The start date from which to retrieve statistics. Must be in ISO 8601 format (YYYY-MM-DD). If not provided, data from the last 90 days will be used by default.
\n","type":"text/plain"},"key":"firstDate","value":"2025-02-25"},{"disabled":true,"description":{"content":"Optional. The end date up to which to retrieve statistics. Must be in ISO 8601 format (YYYY-MM-DD). If not provided, today’s date will be used by default.
\n","type":"text/plain"},"key":"endDate","value":"2025-05-25"},{"disabled":true,"description":{"content":"Optional. External reference ID of the lead.
\n","type":"text/plain"},"key":"referenceId","value":"123456"},{"disabled":true,"description":{"content":"Optional. Unique internal ID of the lead.
\n","type":"text/plain"},"key":"id","value":"123"},{"disabled":true,"description":{"content":"Optional. Customer’s email address.
\n","type":"text/plain"},"key":"customerEmail","value":"correo@karlo.io"},{"disabled":true,"description":{"content":"Optional. The source channel where the lead was generated (e.g., website, facebook).
\n","type":"text/plain"},"key":"canal","value":"GM"}],"variable":[]}},"response":[{"id":"85ccf0cb-7eba-4825-9127-be14d088b560","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.karbot.mx/v1/leads/inbound/?email=correo@karlo.io","protocol":"https","host":["api","karbot","mx"],"path":["v1","leads","inbound",""],"query":[{"key":"referenceId","value":"1203","description":"Optional. External reference ID of the lead.","disabled":true},{"key":"id","value":"123","description":"Optional. Unique internal ID of the lead.","disabled":true},{"key":"canal","value":"GM","description":"Optional. The source channel where the lead was generated (e.g., website, facebook).","disabled":true},{"key":"phoneNumber","value":"3312345678","description":"Optional. Customer’s phone number.","disabled":true},{"key":"email","value":"correo@karlo.io","description":"Optional. Customer’s email address."}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"message\": \"OK\",\n \"statusCode\": 200,\n \"description\": \"Los datos de todos los leads inbound se obtuvieron con éxito.\",\n \"outPut\": [\n {\n \"id\": 2466,\n \"referenceId\": \"1349\",\n \"chatId\": null,\n \"name\": \"Ale 1349\",\n \"phoneNumber\": \"3241962371\",\n \"email\": \"correo@karlo.io\",\n \"interest\": null,\n \"status\": \"CLIENTE IGNORADO\",\n \"canal\": \"SITIO WEB\",\n \"origin\": \"MERCADO LIBRE\",\n \"campaign\": \"promoción 1349\",\n \"adviserName\": null,\n \"createdAt\": \"2025-10-01T19:50:05.192Z\",\n \"information\": {\n \"año\": \"2025\",\n \"marca\": \"marca test\",\n \"modelo\": \"modelo test\",\n \"mensaje\": \"prueba test\",\n \"distribuidor\": \"un distribuidor\"\n }\n },\n {\n \"id\": 2464,\n \"referenceId\": \"2025100103\",\n \"chatId\": null,\n \"name\": \"Alejandro 2025100103\",\n \"phoneNumber\": \"3241962371\",\n \"email\": \"correo@karlo.io\",\n \"interest\": null,\n \"status\": \"CONVERSACION INICIADA\",\n \"canal\": \"SITIO WEB\",\n \"origin\": \"TIENDA\",\n \"campaign\": \"promoción 2025100103\",\n \"adviserName\": null,\n \"createdAt\": \"2025-10-01T17:32:38.837Z\",\n \"information\": {\n \"año\": \"2025\",\n \"marca\": \"marca test\",\n \"modelo\": \"modelo test\",\n \"mensaje\": \"prueba test\",\n \"distribuidor\": \"un distribuidor\"\n }\n },\n {\n \"id\": 2463,\n \"referenceId\": \"2025100102\",\n \"chatId\": null,\n \"name\": \"Alejandro 073002\",\n \"phoneNumber\": \"522025100101\",\n \"email\": \"correo@karlo.io\",\n \"interest\": null,\n \"status\": \"CONVERSACION INICIADA\",\n \"canal\": \"SITIO WEB\",\n \"origin\": \"TIENDA\",\n \"campaign\": \"promoción 2025100102\",\n \"adviserName\": null,\n \"createdAt\": \"2025-10-01T17:00:00.742Z\",\n \"information\": {\n \"año\": \"2025\",\n \"marca\": \"marca test\",\n \"modelo\": \"modelo test\",\n \"mensaje\": \"prueba test\",\n \"distribuidor\": \"un distribuidor\"\n }\n },\n {\n \"id\": 2462,\n \"referenceId\": \"2025100101\",\n \"chatId\": null,\n \"name\": \"Alejandro 073001\",\n \"phoneNumber\": \"522025100101\",\n \"email\": \"correo@karlo.io\",\n \"interest\": null,\n \"status\": \"CONVERSACION INICIADA\",\n \"canal\": \"SITIO WEB\",\n \"origin\": \"TIENDA\",\n \"campaign\": \"promoción 2025100101\",\n \"adviserName\": \"Alejandro Asesor\",\n \"createdAt\": \"2025-10-01T16:59:06.012Z\",\n \"information\": {\n \"año\": \"2025\",\n \"marca\": \"marca test\",\n \"modelo\": \"modelo test\",\n \"mensaje\": \"prueba test\",\n \"distribuidor\": \"un distribuidor\"\n }\n }\n ]\n}"},{"id":"61ed825c-60dd-4cbb-827f-7bbd4a3e2919","name":"Failed","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.karbot.mx/v1/leads/inbound/?firstDate=2025-02-25","protocol":"https","host":["api","karbot","mx"],"path":["v1","leads","inbound",""],"query":[{"key":"referenceId","value":"4321","description":"Optional. External reference ID of the lead.","disabled":true},{"key":"id","value":"123","description":"Optional. Unique internal ID of the lead.","disabled":true},{"key":"canal","value":"GM","description":"Optional. The source channel where the lead was generated (e.g., website, facebook).","disabled":true},{"key":"phoneNumber","value":"3312345678","description":"Optional. Customer’s phone number.","disabled":true},{"key":"email","value":"correo@karlo.io","description":"Optional. Customer’s email address.","disabled":true},{"key":"firstDate","value":"2025-02-25","type":"text"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Bad Request\",\n \"statusCode\": 400,\n \"description\": \"Rango de fechas inválido\",\n \"outPut\": \"Datos de fecha inválidos.\"\n}"},{"id":"464c85dc-1558-4098-bd79-1589446601e8","name":"Unauthorized","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.karbot.mx/v1/leads/inbound/","protocol":"https","host":["api","karbot","mx"],"path":["v1","leads","inbound",""],"query":[{"key":"referenceId","value":"4321","description":"Optional. External reference ID of the lead.","disabled":true},{"key":"id","value":"123","description":"Optional. Unique internal ID of the lead.","disabled":true},{"key":"canal","value":"GM","description":"Optional. The source channel where the lead was generated (e.g., website, facebook).","disabled":true},{"key":"phoneNumber","value":"3312345678","description":"Optional. Customer’s phone number.","disabled":true},{"key":"email","value":"correo@karlo.io","description":"Optional. Customer’s email address.","disabled":true}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"Unauthorized"}],"_postman_id":"ed84fcbe-0924-4666-838f-e45b86c9d89f"},{"name":"Assign Lead Inbound By CrmId","id":"2944e2e3-83bc-4a4f-aa9d-59387cd17483","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Description:
\nThis endpoint allows the creation of inbound leads and automatically assigns the lead to an available advisor based on the specified category. The system ensures that the lead is categorized correctly and routed to the appropriate advisor for personalized follow-up. It supports various lead sources such as websites, social media platforms, or other digital channels.
\nRequest Body:
\ncrmAdviserId: External identifier of the adviser user in the CRM. This field is used to link the external adviser to the corresponding user in Karbot.
\nreferenceId: A unique external identifier for the lead.
\n