Centralize all chats (WhatsApp, Messenger, Instagram, etc.) in a single inbox
\nUse smart bots for lead qualification, business hours, and routing
\nIntegrate with your CRM and view customer data in real time
\nSend styled template messages in bulk (images, buttons, video)
\nManage conversation essentials like labels, quick replies, notes, departments etc.
\nAnd much more!
\nWe serve a wide range of clients, from higher education institutions, insurance agencies, retailers, medical clinics and government entities like the IDF, to SMBs looking for fast, professional WhatsApp communication. TexterChat was founded by two tech entrepreneurs and operates in both Israel and the U.S., headquartered in Tel Aviv. You can learn more at texterchat.com.
\nManage and send your template messages
\nRetrieve chats by ID or by various filters
\nAssign and resolve conversations
\nSend session messages into active chats
\nManage labels
\nMonitor and resolve channel health issues
\nManage quick replies (coming soon)
\nAnd more...
\nFor any questions please contact Texter Support
\nlabelsApiToken.To create a new token go to your Texter environment-
\nhttps://projectID.texterchat.com/server/api/v2
\nFor example, if your environments URL is https://demo.texterchat.com, then your projectID is demo.
\nIn your environment, replace projectID with your actual project ID from Texter.
Set your environment values:
\nprojectID: Your Texter project ID
templatesApiToken: Generate a token for Template routes, include the scopes -
- Send Template Messages
- View Template Messages
- Manage All Chats
- List All Chats
Try the List All Templates request to confirm your connection.
\nYou're ready to go!
\nThis section describes the core entities that appear across multiple API endpoints.
\nEach entity represents a recurring object type - such as templates, chats, messages etc.
With a standardized structure and attributes common to multiple endpoints.
Represents a WhatsApp template in Texter, including internal behavior (chat routing rules, departments, defaults) and provider state (WhatsApp approval status, localized content, quality score).
\nchannelInfoprovider_templateprovider_template contains what WhatsApp “knows” about the template.
Notes:
\nIf provider_template.localizations is empty and you see data under localizationDrafts, that means the template exists in Texter but was not yet approved by WhatsApp.
Some localizations include expiresAt for temporary/limited-time templates.
provider_template.localizatios[]Each item in provider_template.localizations describes one approved localization (language variant) of the template as seen by WhatsApp.
localizatios[].components[]A localization's components array is a list of WhatsApp template components such as:
\nHEADER (may include format and example.header_handle)
BODY (always includes text, may include example.body_text with variable examples)
FOOTER (always includes text)
BUTTONS (includes buttons[])
Component-level structure:
\ndefaultsdefaults is where Texter stores prefill values that will be used when sending the template (especially via the Send Template Message endpoint) if the caller doesn’t explicitly send overrides.
localizationDraftslocalizationDrafts appears when a template exists in Texter but hasn’t been fully submitted/approved by WhatsApp yet.
media[] Object(Used in messages where type: \"media\")
This endpoint is the first of three required to create and submit a new template.
\nWhen a template is first created, it exists only locally and is not yet displayed. The template entity is internal therefore has properties unknown to WhatsApp such as reply action, set bot node etc.
\nAfter creating a template, the next step is to create a localization, which defines all the properties required by WhatsApp - including the language, components (header, body, footer, buttons) and example variable values.
\nFinally, once both the template and its localization have been created, you can submit the template to WhatsApp for approval.
\naccountID - for WhatsApp channels this would be the phone number associated to the account in Texter.On a successful call, the API will respond with the new template object created.
\nIf you didn't specify a template name when creating the template, save the generated name from the response in order to use it when creating a localization and later submitting it to WhatsApp.
\n","urlObject":{"protocol":"https","path":["server","api","v2","whatsapp","templates","{{accountID}}"],"host":["{{projectID}}","texterchat","com"],"query":[],"variable":[]}},"response":[{"id":"843e58eb-1fed-4ffb-8bb5-176e8e70a043","name":"Simple Template","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{templatesApiToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"title\": \"Example Template\",\r\n \"category\": \"MARKETING\",\r\n \"chatStatus\": 1,\r\n \"usage\": \"inbox\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{projectID}}.texterchat.com/server/api/v2/whatsapp/templates/{{accountID}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"server","value":"envoy"},{"key":"date","value":"Mon, 03 Nov 2025 08:33:59 GMT"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"x-powered-by","value":"Express"},{"key":"x-robots-tag","value":"noindex, nofollow"},{"key":"access-control-allow-origin","value":"*"},{"key":"access-control-allow-headers","value":"Authorization"},{"key":"x-version","value":"7.0.0"},{"key":"x-envoy-upstream-service-time","value":"59"},{"key":"content-encoding","value":"gzip"},{"key":"vary","value":"Accept-Encoding"},{"key":"transfer-encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"_id\": \"690868f7962e17ab3033f91b\",\n \"name\": \"inbox_marketing_95\",\n \"channelInfo\": {\n \"name\": \"whatsapp\",\n \"accountId\": \"972509876543\"\n },\n \"chatStatus\": 1,\n \"created\": 1762158839563,\n \"departments\": [],\n \"isDefault\": false,\n \"localizationDrafts\": {},\n \"provider_template\": {\n \"name\": \"inbox_marketing_95\",\n \"category\": \"MARKETING\",\n \"localizations\": [],\n \"metadata\": {}\n },\n \"title\": \"Example Template\",\n \"updatedAt\": \"2025-11-03T08:33:59.563Z\",\n \"usage\": \"inbox\"\n}"},{"id":"867ae1a3-c788-414d-9367-13b42a60e836","name":"Template Routed to Bot","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{templatesApiToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"title\": \"Template to Bot\",\r\n \"category\": \"UTILITY\",\r\n \"chatStatus\": 0,\r\n \"usage\": \"bulk\",\r\n \"setBotNode\": \"new_holiday_campaign\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{projectID}}.texterchat.com/server/api/v2/whatsapp/templates/{{accountID}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"_id\": \"69086d69962e17ab3033f91d\",\n \"channelInfo\": {\n \"name\": \"whatsapp\",\n \"accountId\": \"972509876543\"\n },\n \"name\": \"bulk_utility_97\",\n \"chatStatus\": 0,\n \"created\": 1762159977992,\n \"departments\": [],\n \"isDefault\": false,\n \"localizationDrafts\": {},\n \"provider_template\": {\n \"name\": \"bulk_utility_97\",\n \"category\": \"UTILITY\",\n \"localizations\": [],\n \"metadata\": {}\n },\n \"setBotNode\": \"new_holiday_campaign\",\n \"title\": \"Template to Bot\",\n \"updatedAt\": \"2025-11-03T08:52:57.992Z\",\n \"usage\": \"bulk\"\n}"},{"id":"f3f6cb50-61d4-40da-843a-201d17d26412","name":"Advanced Template","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{templatesApiToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"title\": \"Advanced Example\",\r\n \"category\": \"MARKETING\",\r\n \"chatStatus\": 2,\r\n \"usage\": \"inbox\", \r\n \"name\": \"send_receipt\",\r\n \"isDefault\": true,\r\n \"departments\": [\"business\", \"cf9055b2-95f5-4c08-b4ac-7d87298873c0\"],\r\n \"responsibleAgent\": \"demo@texterchat.com\",\r\n \"replyText\": \"Thanks for your purchase! Can we help with anything else?\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{projectID}}.texterchat.com/server/api/v2/whatsapp/templates/{{accountID}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"_id\": \"6908704c962e17ab3033f91e\",\n \"name\": \"send_receipt\",\n \"channelInfo\": {\n \"name\": \"whatsapp\",\n \"accountId\": \"972509876543\"\n },\n \"chatStatus\": 2,\n \"created\": 1762160716983,\n \"departments\": [\n \"business\",\n \"cf9055b2-95f5-4c08-b4ac-7d87298873c0\"\n ],\n \"isDefault\": true,\n \"localizationDrafts\": {},\n \"provider_template\": {\n \"name\": \"send_receipt\",\n \"category\": \"MARKETING\",\n \"localizations\": [],\n \"metadata\": {}\n },\n \"replyText\": \"Thanks for your purchase! Can we help with anything else?\",\n \"responsibleAgent\": \"demo@texterchat.com\",\n \"title\": \"Advanced Example\",\n \"updatedAt\": \"2025-11-03T09:05:16.982Z\",\n \"usage\": \"inbox\"\n}"},{"id":"75544898-3098-47df-a081-3005c3c93ed4","name":"Error Create Template","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{templatesApiToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"title\": \"Bad Template\",\r\n \"category\": \"UTILITY\",\r\n \"chatStatus\": 5,\r\n \"usage\": \"inbox\",\r\n \"responsibleDepartment\": \"business\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{projectID}}.texterchat.com/server/api/v2/whatsapp/templates/{{accountID}}"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"error\": \"data/chatStatus must be equal to one of the allowed values\"\r\n}"}],"_postman_id":"b90f5df3-0422-43c8-a6d8-b086aa9e58bf"},{"name":"Create or Update Localization","id":"59ddf910-5d8e-4078-92d8-850c3f531568","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{templatesApiToken}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n // Required -\r\n \"language\": \"he\",\r\n \"components\":[\r\n\r\n // Any of HEADER/BODY/FOOTER/BUTTONS - \r\n {\r\n \"type\": \"HEADER\",\r\n \"format\": \"IMAGE | VIDEO | DOCUMENT\",\r\n \"example\": {\r\n \"header_handle\": [\r\n \"Use this endpoint after creating a new template to define or update its core properties - including language, body, header, buttons, and other components.
\nNotice that this can't be used for already submitted templates- if you want to update any of these fields and your templae is already submitted, you ought to create a new template.
\nAfter a successful request, the template will be visible in Texter as a preview. When creating a template via the API for the first time, we recommend reviewing it in Texter before submitting it for approval.
\naccountID - For WhatsApp channels this would be the phone number associated to the account in Texter.
templateName - The unique identifier of the template. This can be either:
- The custom name assigned when the template was created, or
- The system-generated name, which can be retrieved from the response of the template creation endpoint (under the name field).
components[] VariantsHEADERBODYFOOTERBUTTONSQUICK_REPLYURLPHONE_NUMBERFLOWdefaults (Optional)On a successful call, the API will respond with the updated template object along with its added localization.
\n","urlObject":{"protocol":"https","path":["server","api","v2","whatsapp","templates","{{accountID}}","{{templateName}}","localizations"],"host":["{{projectID}}","texterchat","com"],"query":[],"variable":[]}},"response":[{"id":"0872f035-8219-4d58-bb43-e14342040288","name":"Simple Localization","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{templatesApiToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"language\": \"en\",\r\n \"components\":[\r\n {\r\n \"type\": \"BODY\",\r\n \"text\": \"How can we help?\"\r\n },\r\n {\r\n \"type\": \"BUTTONS\",\r\n \"buttons\": [\r\n {\r\n \"type\": \"QUICK_REPLY\",\r\n \"text\": \"About Texter\"\r\n },\r\n {\r\n \"type\": \"QUICK_REPLY\",\r\n \"text\": \"Contact Us\"\r\n }\r\n ]\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{projectID}}.texterchat.com/server/api/v2/whatsapp/templates/{{accountID}}/{{templateName}}/localizations"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"_id\": \"69086d69962e17ab3033f91d\",\n \"channelInfo\": {\n \"name\": \"whatsapp\",\n \"accountId\": \"972509876543\"\n },\n \"name\": \"bulk_utility_97\",\n \"chatStatus\": 0,\n \"created\": 1762159977992,\n \"departments\": [],\n \"isDefault\": false,\n \"localizationDrafts\": {\n \"en\": {\n \"language\": \"en\",\n \"components\": [\n {\n \"type\": \"BODY\",\n \"text\": \"How can we help?\"\n },\n {\n \"type\": \"BUTTONS\",\n \"buttons\": [\n {\n \"type\": \"QUICK_REPLY\",\n \"text\": \"About Texter\"\n },\n {\n \"type\": \"QUICK_REPLY\",\n \"text\": \"Contact Us\"\n }\n ]\n }\n ]\n }\n },\n \"provider_template\": {\n \"name\": \"bulk_utility_97\",\n \"category\": \"UTILITY\",\n \"localizations\": [],\n \"metadata\": {}\n },\n \"setBotNode\": \"new_holiday_campaign\",\n \"title\": \"Template to Bot\",\n \"updatedAt\": \"2025-11-03T08:52:57.992Z\",\n \"usage\": \"bulk\",\n \"defaults\": {\n \"en\": {}\n }\n}"},{"id":"ce33ffe0-fcac-4697-b976-623c8b44b8ab","name":"Advanced Localization","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{templatesApiToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"language\": \"he\",\r\n \"components\":[\r\n {\r\n \"type\": \"HEADER\",\r\n \"format\": \"IMAGE\",\r\n \"example\": {\r\n \"header_handle\": [\r\n \"https://storage.googleapis.com/texter-public-files/customers/ninja/texter-logo.png\"\r\n ]\r\n }\r\n },\r\n {\r\n \"type\": \"BODY\",\r\n \"text\": \"היי {{1}} מעדכן שהזמנה מספר {{2}} מוכנה לאיסוף\",\r\n \"example\": {\r\n \"body_text\": [\r\n [\r\n \"רועי\",\r\n \"15033\"\r\n ]\r\n ]\r\n }\r\n },\r\n {\r\n \"type\": \"FOOTER\",\r\n \"text\": \"להסרה השב הסר\"\r\n },\r\n {\r\n \"type\": \"BUTTONS\",\r\n \"buttons\": [\r\n {\r\n \"type\": \"PHONE_NUMBER\",\r\n \"text\": \"Call here\",\r\n \"phone_number\": \"+972521234567\"\r\n },\r\n {\r\n \"type\": \"URL\",\r\n \"text\": \"Our website\",\r\n \"url\": \"https://www.texterchat.com/{{1}}\",\r\n \"example\": {\r\n \"url\": \"https://www.texterchat.com/blog\"\r\n }\r\n }\r\n ]\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{projectID}}.texterchat.com/server/api/v2/whatsapp/templates/{{accountID}}/{{templateName}}/localizations"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"_id\": \"690868f7962e17ab3033f91b\",\n \"name\": \"inbox_marketing_95\",\n \"channelInfo\": {\n \"name\": \"whatsapp\",\n \"accountId\": \"972509876543\"\n },\n \"chatStatus\": 1,\n \"created\": 1762158839563,\n \"departments\": [],\n \"isDefault\": false,\n \"localizationDrafts\": {\n \"he\": {\n \"language\": \"he\",\n \"components\": [\n {\n \"type\": \"HEADER\",\n \"format\": \"IMAGE\",\n \"example\": {\n \"header_handle\": [\n \"https://storage.googleapis.com/texter-public-files/customers/ninja/texter-logo.png\"\n ]\n }\n },\n {\n \"type\": \"BODY\",\n \"text\": \"היי {{1}} מעדכן שהזמנה מספר {{2}} מוכנה לאיסוף\",\n \"example\": {\n \"body_text\": [\n [\n \"רועי\",\n \"15033\"\n ]\n ]\n }\n },\n {\n \"type\": \"FOOTER\",\n \"text\": \"להסרה השב הסר\"\n },\n {\n \"type\": \"BUTTONS\",\n \"buttons\": [\n {\n \"type\": \"PHONE_NUMBER\",\n \"text\": \"Call here\",\n \"phone_number\": \"+972521234567\"\n },\n {\n \"type\": \"URL\",\n \"text\": \"Our website\",\n \"url\": \"https://www.texterchat.com\"\n }\n ]\n }\n ]\n }\n },\n \"provider_template\": {\n \"name\": \"inbox_marketing_95\",\n \"category\": \"MARKETING\",\n \"localizations\": [],\n \"metadata\": {}\n },\n \"title\": \"Example Template\",\n \"updatedAt\": \"2025-11-03T08:33:59.563Z\",\n \"usage\": \"inbox\",\n \"defaults\": {\n \"he\": {\n \"header\": {\n \"type\": \"image\",\n \"url\": \"https://storage.googleapis.com/texter-public-files/customers/ninja/texter-logo.png\"\n },\n \"body\": [\n \"רועי\",\n \"15033\"\n ]\n }\n }\n}"},{"id":"5a667eb3-300c-4b54-b36a-fae8727ff0cf","name":"Error Create/Update Localization","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{templatesApiToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"language\": \"he\",\r\n \"components\":[\r\n {\r\n \"type\": \"BODY\",\r\n \"text\": \"היי {{1}} איך אפשר לעזור?\",\r\n \"example\": {\r\n \"body_text\": [\r\n [\r\n \"טקסטר\"\r\n ]\r\n ]\r\n }\r\n }\r\n ],\r\n \"defaults\": {\r\n \"body\": [\r\n \"טקסטר\"\r\n ]\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{projectID}}.texterchat.com/server/api/v2/whatsapp/templates/{{accountID}}/{{templateName}}/localizations"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Template welcome_template not found\"\n}"}],"_postman_id":"59ddf910-5d8e-4078-92d8-850c3f531568"},{"name":"Submit Template for Approval","id":"ba2811fa-0364-40bc-a117-4479ed7ebc69","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{templatesApiToken}}"}]},"isInherited":false},"method":"POST","header":[],"url":"https://{{projectID}}.texterchat.com/server/api/v2/whatsapp/templates/{{accountID}}/{{templateName}}/localizations/{{LANG}}/submit","description":"This endpoint is used to submit your template for WhatsApp approval.
It should only be called after you have successfully created a template and then added a localization.
Once submitted, approval usually takes just a few seconds, though in rare cases it can take up to 24 hours. If the template violates any of WhatsApp's rules, it may be denied. You can read more about common reasons for denial here:
https://developers.facebook.com/docs/whatsapp/message-templates/guidelines/
Also note that WhatsApp may approve your template but change its category (commonly from Utility to Marketing) if it determins that the content fits a different classification.
\nTo verify whether your template was approved and to view its full details, use the List All Templates endpoint (which only returns approved template messages).
\naccountID - For WhatsApp channels this would be the phone number associated to the account in Texter.
templateName - The unique identifier of the template. This can be either:
- The custom name assigned when the template was created, or
- The system-generated name, which can be retrieved from the response of the template creation endpoint (under the name field).
LANG - The language specified when creating the template localization (lowercase IETF language tag).
On a successful call, the API will respond with the template object that was submitted.
\n","urlObject":{"protocol":"https","path":["server","api","v2","whatsapp","templates","{{accountID}}","{{templateName}}","localizations","{{LANG}}","submit"],"host":["{{projectID}}","texterchat","com"],"query":[],"variable":[]}},"response":[{"id":"196722eb-05d0-4b40-bf45-4e3842233376","name":"Submit Successful","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{templatesApiToken}}","type":"text"}],"url":"https://{{projectID}}.texterchat.com/server/api/v2/whatsapp/templates/{{accountID}}/{{templateName}}/localizations/{{LANG}}/submit"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"_id\": \"69086d69962e17ab3033f91d\",\n \"channelInfo\": {\n \"name\": \"whatsapp\",\n \"accountId\": \"972509876543\"\n },\n \"name\": \"bulk_utility_97\",\n \"chatStatus\": 0,\n \"created\": 1762159977992,\n \"departments\": [],\n \"isDefault\": false,\n \"localizationDrafts\": {},\n \"provider_template\": {\n \"name\": \"bulk_utility_97\",\n \"category\": \"UTILITY\",\n \"localizations\": [\n {\n \"language\": \"en\",\n \"components\": [\n {\n \"type\": \"BODY\",\n \"text\": \"How can we help?\"\n },\n {\n \"type\": \"BUTTONS\",\n \"buttons\": [\n {\n \"type\": \"QUICK_REPLY\",\n \"text\": \"About Texter\"\n },\n {\n \"type\": \"QUICK_REPLY\",\n \"text\": \"Contact Us\"\n }\n ]\n }\n ],\n \"status\": \"REQUESTED\"\n }\n ],\n \"metadata\": {}\n },\n \"setBotNode\": \"new_holiday_campaign\",\n \"title\": \"Template to Bot\",\n \"updatedAt\": \"2025-11-03T08:52:57.992Z\",\n \"usage\": \"bulk\",\n \"defaults\": {\n \"en\": {}\n }\n}"},{"id":"17593746-18a1-47a3-a0d8-e612a4e86e80","name":"Error Submit Template","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{templatesApiToken}}","type":"text"}],"url":"https://{{projectID}}.texterchat.com/server/api/v2/whatsapp/templates/{{accountID}}/{{templateName}}/localizations/{{LANG}}/submit"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Localization he draft not found\"\n}"}],"_postman_id":"ba2811fa-0364-40bc-a117-4479ed7ebc69"},{"name":"Update Existing Template","id":"e36cdab9-36f4-4289-984c-da1eb3b12721","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{templatesApiToken}}"}]},"isInherited":false},"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n // Required - \r\n \"title\": \"This endpoint allows you to update certain properties of a template, primarily its behavior within Texter.
You can modify any attributes defined during template creation, except for its name and category.
accountID - For WhatsApp channels this would be the phone number associated to the account in Texter.
templateName - The unique identifier of the template. This can be either:
- The custom name assigned when the template was created, or
- The system-generated name, which can be retrieved from the response of the template creation endpoint (under the name field).
On a successful call, the API will respond with the updated template object.
\n","urlObject":{"protocol":"https","path":["server","api","v2","whatsapp","templates","{{accountID}}","{{templateName}}"],"host":["{{projectID}}","texterchat","com"],"query":[],"variable":[]}},"response":[{"id":"51f3cb95-d5f8-4e96-8ce1-62e86ed21161","name":"Update Successful","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{templatesApiToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"title\": \"Updated Template\",\r\n \"chatStatus\": 3,\r\n \"usage\": \"bulk\",\r\n \"replyText\": \"המספר הזה מיועד למענה אוטומטי בלבד, נא לפנות אלינו באמצעי התקשורת האחרים.\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{projectID}}.texterchat.com/server/api/v2/whatsapp/templates/{{accountID}}/{{templateName}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n \"_id\": \"690868f7962e17ab3033f91b\",\r\n \"name\": \"inbox_marketing_95\",\r\n \"channelInfo\": {\r\n \"name\": \"whatsapp\",\r\n \"accountId\": \"972509876543\"\r\n },\r\n \"chatStatus\": 3,\r\n \"created\": 1762158839563,\r\n \"departments\": [],\r\n \"isDefault\": false,\r\n \"localizationDrafts\": {\r\n \"he\": {\r\n \"language\": \"he\",\r\n \"components\": [\r\n {\r\n \"type\": \"HEADER\",\r\n \"format\": \"IMAGE\",\r\n \"example\": {\r\n \"header_handle\": [\r\n \"https://storage.googleapis.com/texter-public-files/customers/ninja/texter-logo.png\"\r\n ]\r\n }\r\n },\r\n {\r\n \"type\": \"BODY\",\r\n \"text\": \"היי {{1}} מעדכן שהזמנה מספר {{2}} מוכנה לאיסוף\",\r\n \"example\": {\r\n \"body_text\": [\r\n [\r\n \"רועי\",\r\n \"15033\"\r\n ]\r\n ]\r\n }\r\n },\r\n {\r\n \"type\": \"FOOTER\",\r\n \"text\": \"להסרה השב הסר\"\r\n },\r\n {\r\n \"type\": \"BUTTONS\",\r\n \"buttons\": [\r\n {\r\n \"type\": \"PHONE_NUMBER\",\r\n \"text\": \"Call here\",\r\n \"phone_number\": \"+972521234567\"\r\n },\r\n {\r\n \"type\": \"URL\",\r\n \"text\": \"Our website\",\r\n \"url\": \"https://www.texterchat.com\"\r\n }\r\n ]\r\n }\r\n ]\r\n }\r\n },\r\n \"provider_template\": {\r\n \"name\": \"inbox_marketing_95\",\r\n \"category\": \"MARKETING\",\r\n \"localizations\": [],\r\n \"metadata\": {}\r\n },\r\n \"title\": \"Updated Template\",\r\n \"updatedAt\": \"2025-11-03T09:46:12.511Z\",\r\n \"usage\": \"bulk\",\r\n \"defaults\": {\r\n \"he\": {\r\n \"header\": {\r\n \"type\": \"image\",\r\n \"url\": \"https://storage.googleapis.com/texter-public-files/customers/ninja/texter-logo.png\"\r\n },\r\n \"body\": [\r\n \"רועי\",\r\n \"15033\"\r\n ]\r\n }\r\n },\r\n \"replyText\": \"המספר הזה מיועד למענה אוטומטי בלבד, נא לפנות אלינו באמצעי התקשורת האחרים.\"\r\n}"},{"id":"5cc1041f-4cbe-4ed6-b20e-baadfbdf2297","name":"Error Update Template","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{templatesApiToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"title\": \"New Name\",\r\n \"chatStatus\": 0,\r\n \"isDefault\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{projectID}}.texterchat.com/server/api/v2/whatsapp/templates/{{accountID}}/{{templateName}}"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"data must have required property 'usage'\"\n}"}],"_postman_id":"e36cdab9-36f4-4289-984c-da1eb3b12721"},{"name":"Delete Template","id":"8799969b-ad01-4495-9363-3fc3692c7b2f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{templatesApiToken}}"}]},"isInherited":false},"method":"DELETE","header":[],"url":"https://{{projectID}}.texterchat.com/server/api/v2/whatsapp/templates/{{accountID}}/{{templateName}}","description":"Permanently delete a template message.
\naccountID - For WhatsApp channels this would be the phone number associated to the account in Texter.
templateName - The unique identifier of the template. This can be either:
- The custom name assigned when the template was created, or
- The system-generated name, which can be retrieved from the response of the template creation endpoint (under the name field).
This endpoint allows you to send an existing template message.
Here you can provide dynamic variables, attachments, and metadata about the recipient.
You may also override certain predefined behaviors, such as the action performed after the recipient replies to the template.
\nReturns an object describing the result of the send operation.
\nsuccess – Boolean indicating whether the template message was successfully sent
text – The final rendered message text after inserting all variable values
sentAsSessionMessage – Boolean indicating whether the message was sent as a session message instead of a template message
messageId – Unique identifier of the message created in Texter
Retrieve all approved templates.
You may optionally specify an account ID if multiple channels are connected, and you can filter templates by whether they include headers (file, image, or video).
Additionally you can retrieve all templates including pending and rejected.
An array of all the relevant template objects.
\n","urlObject":{"protocol":"https","path":["server","api","v2","whatsapp","templates"],"host":["{{projectID}}","texterchat","com"],"query":[{"disabled":true,"description":{"content":"When set to true, returns only templates that include a header. When set to false, excludes all templates that contain a header
\n","type":"text/plain"},"key":"hasHeader","value":""},{"disabled":true,"description":{"content":"Filters results to template messages belonging to the specified account
\n","type":"text/plain"},"key":"accountId","value":""},{"disabled":true,"description":{"content":"When set to true, returns all templates including pending and rejected
\n","type":"text/plain"},"key":"includeAll","value":""},{"disabled":true,"description":{"content":"When set to true, triggers a real-time synchronization with the WhatsApp API before returning the list (requires accountId to prevent performance overhead)
This section contains all endpoints related to the creation, management, and delivery of WhatsApp template messages within Texter.
\nYou can use these endpoints to create, localize, submit, update, delete and send template messages, as well as to retrieve approved templates for your connected WhatsApp accounts.
\nGenerate a token with the following scopes:
\nSend Template Messages
\nView Template Messages
\nManage WhatsApp Templates
\nManage All Chats
\nList All Chats
\nAnd store it in templatesApiToken
Unsubscribe a recipient from template messages.
A recipient can unsubscribe by replying with \"הסר\" to a template message they received, or you can remove them manually in Texter or via the API using this endpoint.
Once unsubscribed, they will no longer receive template messages. Any attempt to send a template message to an unsubscribed recipient will be skipped automatically.
\nYou can re-subscribe them at any time using the Resubscribe to Templates endpoint.
\nOn a successful API call, will return success = true
Subscribe a recipient to receive template messages.
By default, all recipients are subscribed. They become unsubscribed only if they opt out themselves or are removed manually in Texter or via API using the Unsubscribe from Templates endpoint.
While subscribed, they will continue receiving template messages as usual. If unsubscribed, any attempt to send a template message to them will be skipped automatically.
\nOn a successful API call, will return success = true
Retrieve all unsubscribed recipients.
This endpoint returns every unsubscribed recipient accross all channels. If you only want to fetch unsubscribed recipients for a specific channel, use the Unsubscribed from Specific Account endpoint instead.
Returns an array of unsubscribed recipients across all messaging channels.
\nEach object in the array represents an unsubscribed recipient and includes the fields-
\ntitle - their display name (as shown in WhatsApp or other channels)
phone - phone number in international format.
The maximum number of results to return
\n","type":"text/plain"},"key":"limit","value":""},{"disabled":true,"description":{"content":"The number of results to skip before starting to return records
\n","type":"text/plain"},"key":"skip","value":""}],"variable":[]}},"response":[{"id":"28f257bf-fcc2-43ce-aaa4-d1ffe8980c52","name":"All Unsubscribed Users","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{templatesApiToken}}","type":"text"}],"url":{"raw":"https://{{projectID}}.texterchat.com/server/api/v2/whatsapp/templates/unsubscribed?limit=5","protocol":"https","host":["{{projectID}}","texterchat","com"],"path":["server","api","v2","whatsapp","templates","unsubscribed"],"query":[{"key":"limit","value":"5","description":"The maximum number of results to return"},{"key":"skip","value":"","description":"The number of results to skip before starting to return records","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"title\": \"🌸\",\n \"phone\": \"+972529876543\"\n },\n {\n \"title\": \"Eli Cohen\",\n \"phone\": \"+972549431678\"\n },\n {\n \"title\": \"972521234567\",\n \"phone\": \"+972521234567\"\n },\n {\n \"phone\": \"+972534226703\"\n },\n {\n \"title\": \"Texter Support\",\n \"phone\": \"+972555026806\"\n }\n]"},{"id":"fc719924-55b0-490c-b4c4-71ddbb047251","name":"Error Get Unsubscribed","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{templatesApiToken}}","type":"text"}],"url":{"raw":"https://{{projectID}}.texterchat.com/server/api/v2/whatsapp/templates/unsubscribed?limit=50000&skip=2","protocol":"https","host":["{{projectID}}","texterchat","com"],"path":["server","api","v2","whatsapp","templates","unsubscribed"],"query":[{"key":"limit","value":"50000","description":"The maximum number of results to return"},{"key":"skip","value":"2","description":"The number of results to skip before starting to return records"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"data/limit must match pattern \\\"^[1-9][0-9]{0,3}$\\\"\"\n}"}],"_postman_id":"5659ea0f-6d30-4403-9b13-ed7abdba916a"},{"name":"Unsubscribed from Specific Account","id":"94224455-3ef4-4942-8d32-c13e0ee60d5a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{templatesApiToken}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://{{projectID}}.texterchat.com/server/api/v2/whatsapp/templates/unsubscribed/{{accountID}}","description":"Retrieve all unsubscribed recipients from a specific account.
Use this endpoint to fetch all recipients who have unsubscribed from template messages under a given account (channel), speciified by the account ID.
If you want to retrieve unsubscribed recipients across all accounts, use the List All Unsubscribed Users endpoint instead.
\naccountID - For WhatsApp channels this would be the phone number associated to the account in Texter.Returns an array of unsubscribed recipients from the account specified in the request.
\nEach object in the array represents an unsubscribed recipient and includes the fields-title - their display name (as shown in WhatsApp or other channels)phone - phone number in international format.
The maximum number of results to return
\n","type":"text/plain"},"key":"limit","value":""},{"disabled":true,"description":{"content":"The number of results to skip before starting to return records
\n","type":"text/plain"},"key":"skip","value":""}],"variable":[]}},"response":[{"id":"0abf00aa-0790-4950-b878-dd91fb56cb59","name":"All Unsubscribed from Account","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{templatesApiToken}}","type":"text"}],"url":{"raw":"https://{{projectID}}.texterchat.com/server/api/v2/whatsapp/templates/unsubscribed/{{accountID}}?limit=2","protocol":"https","host":["{{projectID}}","texterchat","com"],"path":["server","api","v2","whatsapp","templates","unsubscribed","{{accountID}}"],"query":[{"key":"limit","value":"2","description":"The maximum number of results to return\n\n"},{"key":"skip","value":"","description":"The number of results to skip before starting to return records\n\n","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"title\": \"John Doe\",\n \"phone\": \"+972549431678\"\n },\n {\n \"title\": \"Texter Support\",\n \"phone\": \"+972555026806\"\n }\n]"},{"id":"041ba35a-8fdf-4eea-8a1f-65d13ef4baa3","name":"Error Get Unsubscribed from Account","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{templatesApiToken}}","type":"text"}],"url":{"raw":"https://{{projectID}}.texterchat.com/server/api/v2/whatsapp/templates/unsubscribed/{{accountID}}","protocol":"https","host":["{{projectID}}","texterchat","com"],"path":["server","api","v2","whatsapp","templates","unsubscribed","{{accountID}}"],"query":[{"key":"limit","value":"","disabled":true},{"key":"skip","value":"","description":"The number of results to skip before starting to return records\n\n","disabled":true}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"WhatsApp account 972540202020 not found\"\n}"}],"_postman_id":"94224455-3ef4-4942-8d32-c13e0ee60d5a"}],"id":"7bb05896-8be0-4eee-ab71-a6ae1fe2dbd6","description":"This section contains all endpoints related to managing recipients subscriptions for WhatsApp template messages.
\nYou can use these endpoints to subscribe or unsubscribe recipients, as well as to retrieve lists of unsubscribed users - either across all channels or for a specific WhatsApp account.
\nGenerate a token with the following scopes:
\nSend Template Messages
\nView Template Messages
\nManage WhatsApp Templates
\nManage All Chats
\nList All Chats
\nAnd store it in templatesApiToken
Retrieve all messages from a specific chat.
By default, this endpoint returns the last 50 messages in ascending order (from earliest to latest). You can change this limit or apply filters refine the rsults.
Available filters:
\nBot session - Retrieve all messages from a specific bot session by providing the botSessionId.
You can obtain this ID via the Search Chats endpoint (using the customer's phone number for example), or by calling Get Chat by Chat ID using the chat ID.
The chat object includes a botState field and a previousBotSession field where you can find the session ID.
Before time & before ID - Both parameters must be provided together:
- beforeId - The message ID to use as a cutoff
- beforeTime - Before a certain timestamp (Unix epoch time in milliseconds)
The response will include all messages before the given message ID and before the specified time.
chatID - The unique identifier of the chat. You can obtain this value by using the Search Chats endpoint with the customer's phone number.Returns a messages array containing all message objects that match the query paramaters.
Additionally includes two timestamps values for the chat:
\nminTime - The timestamp (in milliseconds) of the first-ever message in the chat.
maxTime - The timestamp (in milliseconds) of the most recent message in the chat.
The maximum number of results to return
\n","type":"text/plain"},"key":"limit","value":""},{"disabled":true,"description":{"content":"Get messages before the spcified timestamp
\nGet messages before the specified message ID
\nGet message within the specified bot session, specified by the bot state ID
\n","type":"text/plain"},"key":"botSessionId","value":""}],"variable":[]}},"response":[{"id":"b752d6b7-475b-472f-b7a7-f207cdb5a69c","name":"Messages Before Time","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{messagesApiToken}}","type":"text"}],"url":{"raw":"https://{{projectID}}.texterchat.com/server/api/v2/messages/chat/{{chatID}}?beforeTime=1757055874154&beforeId=68ba8c904657483ffee3101e","protocol":"https","host":["{{projectID}}","texterchat","com"],"path":["server","api","v2","messages","chat","{{chatID}}"],"query":[{"key":"limit","value":"","description":"The maximum number of results to return\n\n","disabled":true},{"key":"beforeTime","value":"1757055874154","description":"Get messages before the spcified timestamp\n* Required to use with \"beforeId\""},{"key":"beforeId","value":"68ba8c904657483ffee3101e","description":"Get messages before the specified message ID\n* Required to use with \"beforeTime\""},{"key":"botSessionId","value":"","description":"Get message within the specified bot session, specified by the bot state ID","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"messages\": [\n {\n \"_id\": \"68ba89f8c909657dffcf267c\",\n \"channelInfo\": {\n \"id\": \"wamid.HBgMOTcyNTQ0NTU0ODUyFQIAEhgUM0ExNkMwMzdBN0Q0MDFEN0E4RUUA\",\n \"metadata\": {\n \"frequentlyForwarded\": false\n }\n },\n \"chatChannelInfo\": {\n \"name\": \"whatsapp\",\n \"id\": \"972521234567\",\n \"accountId\": \"972509876543\"\n },\n \"direction\": \"incoming\",\n \"forwarded\": false,\n \"incoming\": true,\n \"outgoing\": false,\n \"parent_chat\": \"67a87067aeedqdee1271ck4d\",\n \"received\": 1757055477000,\n \"status\": 2,\n \"statusHistory\": [\n {\n \"status\": 2,\n \"timestamp\": 1757055477000\n }\n ],\n \"text\": \"Hi\",\n \"timestamp\": 1757055477000,\n \"type\": \"text\",\n \"updatedAt\": \"2025-09-05T06:58:01.651Z\",\n \"metadata\": {\n \"triggeredBot\": true\n },\n \"botSessionId\": \"c1125880930b372b0f1047cad91ab5aca4f1171993d8af709497d16f77772fa4\"\n },\n {\n \"_id\": \"68ba89f9c909657dffcf26a6\",\n \"channelInfo\": {\n \"id\": \"wamid.HBgMOTcyNTQ0NTU0ODUyFQIAERgSOTQ4RDUzODA3OTgwNkJFOTMyAA==\"\n },\n \"chatChannelInfo\": {\n \"name\": \"whatsapp\",\n \"id\": \"972521234567\",\n \"accountId\": \"972509876543\"\n },\n \"agent\": \"bot\",\n \"botMsgInfo\": {\n \"identifier\": \"Niv-test-bot\",\n \"version\": 35,\n \"nodeName\": \"start\",\n \"hideSummary\": false\n },\n \"botSessionId\": \"c1125880930b372b0f1047cad91ab5aca4f1171993d8af709497d16f77772fa4\",\n \"direction\": \"outgoing\",\n \"incoming\": false,\n \"metadata\": {\n \"botMsgInfo\": {\n \"identifier\": \"Niv-test-bot\",\n \"version\": 35,\n \"nodeName\": \"start\",\n \"hideSummary\": false\n }\n },\n \"outgoing\": true,\n \"parent_chat\": \"67a87067aeedqdee1271ck4d\",\n \"received\": 1757055481534,\n \"status\": 3,\n \"statusHistory\": [\n {\n \"status\": 0,\n \"timestamp\": 1757055481534\n },\n {\n \"timestamp\": 1757055482000,\n \"status\": 1\n },\n {\n \"timestamp\": 1757055483000,\n \"status\": 2\n },\n {\n \"timestamp\": 1757055483000,\n \"status\": 3\n }\n ],\n \"text\": \"היי! הגעתם לבוט הAI של פעמוני מותססים \",\n \"timestamp\": 1757055481534,\n \"type\": \"text\",\n \"updatedAt\": \"2025-09-05T06:58:04.571Z\"\n },\n {\n \"_id\": \"68ba89fac909657dffcf26b7\",\n \"channelInfo\": {\n \"id\": \"wamid.HBgMOTcyNTQ0NTU0ODUyFQIAERgSMzc3MDczM0M0RkMzMjQzNzQ2AA==\"\n },\n \"chatChannelInfo\": {\n \"name\": \"whatsapp\",\n \"id\": \"972521234567\",\n \"accountId\": \"972509876543\"\n },\n \"agent\": \"bot\",\n \"botMsgInfo\": {\n \"identifier\": \"Niv-test-bot\",\n \"version\": 35,\n \"nodeName\": \"general_info\",\n \"hideSummary\": false\n },\n \"botSessionId\": \"c1125880930b372b0f1047cad91ab5aca4f1171993d8af709497d16f77772fa4\",\n \"direction\": \"outgoing\",\n \"incoming\": false,\n \"metadata\": {\n \"botMsgInfo\": {\n \"identifier\": \"Niv-test-bot\",\n \"version\": 35,\n \"nodeName\": \"general_info\",\n \"hideSummary\": false\n }\n },\n \"outgoing\": true,\n \"parent_chat\": \"67a87067aeedqdee1271ck4d\",\n \"received\": 1757055482132,\n \"status\": 3,\n \"statusHistory\": [\n {\n \"status\": 0,\n \"timestamp\": 1757055482132\n },\n {\n \"timestamp\": 1757055483000,\n \"status\": 1\n },\n {\n \"timestamp\": 1757055484000,\n \"status\": 2\n },\n {\n \"timestamp\": 1757055484000,\n \"status\": 3\n }\n ],\n \"text\": \"הבוט שלנו ישמח לתת לכם מענה 24/7\\nחשוב לציין, המידע שניתן הוא מבוסס בינה מלאכותית ולפעמים יש טעויות, המידע המדויק ביותר מתעדכן תמיד באתר שלנו בכתובת-\\nhttps://paamoniferments.com/\\n\\nאנא שלחו את שאלתכם ונשמח לעמוד לשירותכם\",\n \"timestamp\": 1757055482132,\n \"type\": \"text\",\n \"updatedAt\": \"2025-09-05T06:58:05.291Z\"\n },\n {\n \"_id\": \"68ba8a10c909657dffcf27be\",\n \"channelInfo\": {\n \"id\": \"wamid.HBgMOTcyNTQ0NTU0ODUyFQIAEhgUM0FEMUIzMzQ0OENBRkQ3MjU1NUIA\",\n \"metadata\": {\n \"frequentlyForwarded\": false\n }\n },\n \"chatChannelInfo\": {\n \"name\": \"whatsapp\",\n \"id\": \"972521234567\",\n \"accountId\": \"972509876543\"\n },\n \"direction\": \"incoming\",\n \"forwarded\": false,\n \"incoming\": true,\n \"outgoing\": false,\n \"parent_chat\": \"67a87067aeedqdee1271ck4d\",\n \"received\": 1757055502000,\n \"status\": 2,\n \"statusHistory\": [\n {\n \"status\": 2,\n \"timestamp\": 1757055502000\n }\n ],\n \"text\": \"כמה מוצרים בעצם יש לכם?\",\n \"timestamp\": 1757055502000,\n \"type\": \"text\",\n \"updatedAt\": \"2025-09-05T06:58:24.056Z\",\n \"metadata\": {\n \"triggeredBot\": true\n }\n },\n {\n \"_id\": \"68ba8a21c909657dffcf28a5\",\n \"channelInfo\": {\n \"id\": \"wamid.HBgMOTcyNTQ0NTU0ODUyFQIAERgSNTVCRTk2NDEwQThENUIwNEI0AA==\"\n },\n \"chatChannelInfo\": {\n \"name\": \"whatsapp\",\n \"id\": \"972521234567\",\n \"accountId\": \"972509876543\"\n },\n \"direction\": \"outgoing\",\n \"incoming\": false,\n \"outgoing\": true,\n \"parent_chat\": \"67a87067aeedqdee1271ck4d\",\n \"received\": 1757055521481,\n \"status\": 3,\n \"statusHistory\": [\n {\n \"status\": 0,\n \"timestamp\": 1757055521481\n },\n {\n \"timestamp\": 1757055521000,\n \"status\": 1\n },\n {\n \"timestamp\": 1757055522000,\n \"status\": 2\n },\n {\n \"timestamp\": 1757150385000,\n \"status\": 3\n }\n ],\n \"text\": \"יש לנו מגוון רחב של מוצרים מתוססים שונים, המותאמים להעדפות ולצרכים שונים. עדיף לבדוק פרטים מדויקים על המוצרים הזמינים באתר שלנו או לפנות ישירות לשירות הלקוחות שלנו לקבלת מידע נוסף.\",\n \"timestamp\": 1757055521481,\n \"type\": \"text\",\n \"updatedAt\": \"2025-09-06T09:19:48.352Z\"\n },\n {\n \"_id\": \"68ba8b82c909657dffcf3667\",\n \"channelInfo\": {\n \"id\": \"wamid.HBgMOTcyNTQ0NTU0ODUyFQIAERgSNEMzODlGMzNDODY0QzcyQTlCAA==\"\n },\n \"chatChannelInfo\": {\n \"name\": \"whatsapp\",\n \"id\": \"972521234567\",\n \"accountId\": \"972509876543\"\n },\n \"direction\": \"outgoing\",\n \"incoming\": false,\n \"outgoing\": true,\n \"parent_chat\": \"67a87067aeedqdee1271ck4d\",\n \"received\": 1757055874154,\n \"status\": 3,\n \"statusHistory\": [\n {\n \"status\": 0,\n \"timestamp\": 1757055874154\n },\n {\n \"timestamp\": 1757055874000,\n \"status\": 1\n },\n {\n \"timestamp\": 1757055877000,\n \"status\": 2\n },\n {\n \"timestamp\": 1757150385000,\n \"status\": 3\n }\n ],\n \"text\": \"היי, עדיין פה?\",\n \"timestamp\": 1757055874154,\n \"type\": \"text\",\n \"updatedAt\": \"2025-09-06T09:19:48.834Z\"\n }\n ],\n \"minTime\": 1757055477000,\n \"maxTime\": 1757056631720\n}"},{"id":"d9572681-b06b-49e8-8a91-969de88f8844","name":"Messages by Bot Session","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{messagesApiToken}}","type":"text"}],"url":{"raw":"https://{{projectID}}.texterchat.com/server/api/v2/messages/chat/{{chatID}}?botSessionId=694cc065571521039d74a51044e89b932fe3310290d7c7db75fb0ccad343c9da","protocol":"https","host":["{{projectID}}","texterchat","com"],"path":["server","api","v2","messages","chat","{{chatID}}"],"query":[{"key":"limit","value":"","description":"The maximum number of results to return\n\n","disabled":true},{"key":"beforeTime","value":"","description":"Get messages before the spcified timestamp\n* Required to use with \"beforeId\"","disabled":true},{"key":"beforeId","value":"","description":"Get messages before the specified message ID\n* Required to use with \"beforeTime\"","disabled":true},{"key":"botSessionId","value":"694cc065571521039d74a51044e89b932fe3310290d7c7db75fb0ccad343c9da","description":"Get message within the specified bot session, specified by the bot state ID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"messages\": [\n {\n \"_id\": \"68ba8c91c909657dffcf409a\",\n \"channelInfo\": {\n \"id\": \"wamid.HBgMOTcyNTQ0NTU0ODUyFQIAERgSMEU3NEZCMkZGMTYxQ0NGQjE3AA==\"\n },\n \"chatChannelInfo\": {\n \"name\": \"whatsapp\",\n \"id\": \"972521234567\",\n \"accountId\": \"972509876543\"\n },\n \"agent\": \"bot\",\n \"botMsgInfo\": {\n \"identifier\": \"Niv-test-bot\",\n \"version\": 35,\n \"nodeName\": \"ai_inactivity_msg\",\n \"hideSummary\": false\n },\n \"botSessionId\": \"694cc065571521039d74a51044e89b932fe3310290d7c7db75fb0ccad343c9da\",\n \"direction\": \"outgoing\",\n \"incoming\": false,\n \"metadata\": {\n \"botMsgInfo\": {\n \"identifier\": \"Niv-test-bot\",\n \"version\": 35,\n \"nodeName\": \"ai_inactivity_msg\",\n \"hideSummary\": false\n }\n },\n \"outgoing\": true,\n \"parent_chat\": \"67a87067aeedqdee1271ck4d\",\n \"received\": 1757056145167,\n \"status\": 3,\n \"statusHistory\": [\n {\n \"status\": 0,\n \"timestamp\": 1757056145167\n },\n {\n \"timestamp\": 1757056145000,\n \"status\": 1\n },\n {\n \"timestamp\": 1757056148000,\n \"status\": 2\n },\n {\n \"timestamp\": 1757150385000,\n \"status\": 3\n }\n ],\n \"text\": \"מכיוון שחלף זמן מה ללא תגובה, החזרנו אותך לבוט הרגיל להמשך טיפול.\",\n \"timestamp\": 1757056145167,\n \"type\": \"text\",\n \"updatedAt\": \"2025-09-06T09:19:48.360Z\"\n },\n {\n \"_id\": \"68ba8c91c909657dffcf40b2\",\n \"channelInfo\": {\n \"id\": \"wamid.HBgMOTcyNTQ0NTU0ODUyFQIAERgSMUQ3OTJBRERGRDM0RTAwOTVGAA==\"\n },\n \"chatChannelInfo\": {\n \"name\": \"whatsapp\",\n \"id\": \"972521234567\",\n \"accountId\": \"972509876543\"\n },\n \"agent\": \"bot\",\n \"botMsgInfo\": {\n \"identifier\": \"Niv-test-bot\",\n \"version\": 35,\n \"nodeName\": \"whats_next\",\n \"hideSummary\": false\n },\n \"botSessionId\": \"694cc065571521039d74a51044e89b932fe3310290d7c7db75fb0ccad343c9da\",\n \"buttons\": [\n {\n \"title\": \"לתפריט הראשי\",\n \"payload\": \"1\"\n },\n {\n \"title\": \"סגירת פנייה\",\n \"payload\": \"2\"\n }\n ],\n \"direction\": \"outgoing\",\n \"incoming\": false,\n \"metadata\": {\n \"botMsgInfo\": {\n \"identifier\": \"Niv-test-bot\",\n \"version\": 35,\n \"nodeName\": \"whats_next\",\n \"hideSummary\": false\n }\n },\n \"outgoing\": true,\n \"parent_chat\": \"67a87067aeedqdee1271ck4d\",\n \"received\": 1757056145969,\n \"status\": 3,\n \"statusHistory\": [\n {\n \"status\": 0,\n \"timestamp\": 1757056145969\n },\n {\n \"timestamp\": 1757056146000,\n \"status\": 1\n },\n {\n \"timestamp\": 1757056148000,\n \"status\": 2\n },\n {\n \"timestamp\": 1757150385000,\n \"status\": 3\n }\n ],\n \"text\": \"איך אפשר עוד לעזור?\",\n \"timestamp\": 1757056145969,\n \"type\": \"buttons\",\n \"updatedAt\": \"2025-09-06T09:19:48.832Z\"\n },\n {\n \"_id\": \"68ba8d4cc909657dffcf4814\",\n \"channelInfo\": {\n \"id\": \"wamid.HBgMOTcyNTQ0NTU0ODUyFQIAERgSNjZDNjY0QzhEMTExQjQ3QUI1AA==\"\n },\n \"chatChannelInfo\": {\n \"name\": \"whatsapp\",\n \"id\": \"972521234567\",\n \"accountId\": \"972509876543\"\n },\n \"agent\": \"bot\",\n \"botMsgInfo\": {\n \"identifier\": \"Niv-test-bot\",\n \"version\": 35,\n \"nodeName\": \"whats_next\",\n \"hideSummary\": false\n },\n \"botSessionId\": \"694cc065571521039d74a51044e89b932fe3310290d7c7db75fb0ccad343c9da\",\n \"direction\": \"outgoing\",\n \"incoming\": false,\n \"metadata\": {\n \"botMsgInfo\": {\n \"identifier\": \"Niv-test-bot\",\n \"version\": 35,\n \"nodeName\": \"whats_next\",\n \"hideSummary\": false\n }\n },\n \"outgoing\": true,\n \"parent_chat\": \"67a87067aeedqdee1271ck4d\",\n \"received\": 1757056332449,\n \"status\": 3,\n \"statusHistory\": [\n {\n \"status\": 0,\n \"timestamp\": 1757056332449\n },\n {\n \"timestamp\": 1757056332000,\n \"status\": 1\n },\n {\n \"timestamp\": 1757056334000,\n \"status\": 2\n },\n {\n \"timestamp\": 1757150385000,\n \"status\": 3\n }\n ],\n \"text\": \"לא התקבלה תגובה, אתה עדיין שם?\",\n \"timestamp\": 1757056332449,\n \"type\": \"text\",\n \"updatedAt\": \"2025-09-06T09:19:48.251Z\"\n },\n {\n \"_id\": \"68ba8e77c909657dffcf535b\",\n \"channelInfo\": {\n \"id\": \"wamid.HBgMOTcyNTQ0NTU0ODUyFQIAERgSMTE2QjE2QjBBMDhDRTBBQzNEAA==\"\n },\n \"chatChannelInfo\": {\n \"name\": \"whatsapp\",\n \"id\": \"972521234567\",\n \"accountId\": \"972509876543\"\n },\n \"agent\": \"bot\",\n \"botMsgInfo\": {\n \"identifier\": \"Niv-test-bot\",\n \"version\": 35,\n \"nodeName\": \"close_bot_sequence\",\n \"hideSummary\": false\n },\n \"botSessionId\": \"694cc065571521039d74a51044e89b932fe3310290d7c7db75fb0ccad343c9da\",\n \"direction\": \"outgoing\",\n \"incoming\": false,\n \"metadata\": {\n \"botMsgInfo\": {\n \"identifier\": \"Niv-test-bot\",\n \"version\": 35,\n \"nodeName\": \"close_bot_sequence\",\n \"hideSummary\": false\n }\n },\n \"outgoing\": true,\n \"parent_chat\": \"67a87067aeedqdee1271ck4d\",\n \"received\": 1757056631574,\n \"status\": 3,\n \"statusHistory\": [\n {\n \"status\": 0,\n \"timestamp\": 1757056631574\n },\n {\n \"timestamp\": 1757056631000,\n \"status\": 1\n },\n {\n \"timestamp\": 1757056632000,\n \"status\": 2\n },\n {\n \"timestamp\": 1757150385000,\n \"status\": 3\n }\n ],\n \"text\": \"לא התקבלה תגובה במשך זמן מה, הבוט נסגר. אם תצטרך עזרה נוספת, תוכל לפנות שוב מאוחר יותר.\",\n \"timestamp\": 1757056631574,\n \"type\": \"text\",\n \"updatedAt\": \"2025-09-06T09:19:48.256Z\"\n },\n {\n \"_id\": \"68ba8e774657483ffee3103b\",\n \"systemMessage\": true,\n \"newChatStatus\": 3,\n \"timestamp\": 1757056631720,\n \"received\": 1757056631720,\n \"parent_chat\": \"67a87067aeedqdee1271ck4d\",\n \"botSessionId\": \"694cc065571521039d74a51044e89b932fe3310290d7c7db75fb0ccad343c9da\",\n \"updatedAt\": \"2025-09-05T07:17:11.720Z\",\n \"chatChannelInfo\": {\n \"name\": \"whatsapp\",\n \"id\": \"972521234567\",\n \"accountId\": \"972509876543\"\n },\n \"channelInfo\": {\n \"id\": \"c7fc8105-8575-4beb-9a8f-b109acfc6dfd\"\n },\n \"agent\": \"Bot\"\n }\n ],\n \"minTime\": 1757055477000,\n \"maxTime\": 1757056631720\n}"},{"id":"391465ba-ca7d-48c5-9b7c-e9a9d3cf4116","name":"Error Get Messages","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{messagesApiToken}}","type":"text"}],"url":{"raw":"https://{{projectID}}.texterchat.com/server/api/v2/messages/chat/{{chatID}}?beforeTime=1762179779000","protocol":"https","host":["{{projectID}}","texterchat","com"],"path":["server","api","v2","messages","chat","{{chatID}}"],"query":[{"key":"limit","value":"","description":"The maximum number of results to return\n\n","disabled":true},{"key":"beforeTime","value":"1762179779000","description":"Get messages before the spcified timestamp\n* Required to use with \"beforeId\""},{"key":"beforeId","value":"","description":"Get messages before the specified message ID\n* Required to use with \"beforeTime\"","disabled":true},{"key":"botSessionId","value":"","description":"Get message within the specified bot session, specified by the bot state ID","disabled":true}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"data must have required property 'botSessionId', data must have required property 'beforeId', data must match a schema in anyOf\"\n}"}],"_postman_id":"390c95b0-ee41-4c96-b97d-2d0370005cf9"},{"name":"Send a Message to Chat","id":"ecb157c5-b03a-41b9-9132-8a4a48950bd4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{messagesApiToken}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"type\": \"text\",\r\n \"text\": \"This is an example - check all the examples for more complex message types\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{projectID}}.texterchat.com/server/api/v2/messages/send/{{chatID}}","description":"Send a session message to a chat.
Use this endpoint to send a regular session message to a chat. Messages can include text or media (image, video, or document).
⚠ Important: Session messages are subject to WhatsApp's 24-hour window. If the customer has not sent a message in the last 24 hours, WhatsApp block session messages and the request will fail. In that case, you can only Send Template Messages.
\nchatID - The unique identifier of the chat. You can obtain this value by using the Search Chats endpoint with the customer's phone number.These parameters are available for every message request, regardless of the type.
Required when type = \"text\"
Required when type = \"media\"
Required when type = \"buttons\"
Required when type = \"list\"
On a successful call, the API returns a confirmation object containing the sent message(s).
\nThe response includes a success flag and a messages array with the newly created message objects.
This section contains all endpoints related to retrieving and sending messages within chats.
\nYou can use these endpoints to fetch message history from a specific chat or to send new session messages, including text and media, within the active WhatsApp session window.
\nGenerate a token with the following scopes:
\nSend Session Message
\nView All Chats
\nAnd store it in messagesApiToken
Retrieve a chat by its ID - fetch the full chat object using the chatID
\nchatID - The unique identifier of the chat. You can obtain this value by using the Search Chats endpoint with the customer's phone number.Returns the chat object.
\n","urlObject":{"protocol":"https","path":["server","api","v2","chats","{{chatID}}"],"host":["{{projectID}}","texterchat","com"],"query":[],"variable":[]}},"response":[{"id":"44dd90ca-87f7-4cba-9b37-1fcd6b0b9d37","name":"Get Chat Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{chatsApiToken}}","type":"text"}],"url":"https://{{projectID}}.texterchat.com/server/api/v2/chats/{{chatID}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"title\": \"Niv Shteingart\",\n \"channelInfo\": {\n \"name\": \"whatsapp\",\n \"id\": \"972521234567\",\n \"accountId\": \"972549876543\"\n },\n \"departmentId\": null,\n \"agent\": {\n \"uid\": null,\n \"displayName\": \"\"\n },\n \"status\": 0,\n \"created\": \"2025-05-07T11:09:03.295Z\",\n \"updatedAt\": \"2025-11-03T20:05:15.532Z\",\n \"lastIncomingMessageTimestamp\": 1762200310000,\n \"lastMessage\": {\n \"type\": \"text\",\n \"text\": \"מה שמך?\"\n },\n \"unreadCount\": 2,\n \"botState\": {\n \"id\": \"236ef058aa87c90536c33493d2024cd87055bdac4d64a0f22fd84fcb3cea6f8d\"\n },\n \"lastMessageTimestamp\": 1762200315209\n}"},{"id":"f95db8c0-454c-48dc-ac51-7525452a1026","name":"Error Get Chat","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{chatsApiToken}}","type":"text"}],"url":"https://{{projectID}}.texterchat.com/server/api/v2/chats/{{chatID}}"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Chat not found\",\n \"success\": false\n}"}],"_postman_id":"0888e955-dfc5-4fd5-983d-d7d8ee589101"},{"name":"Search Chats","id":"5dd68f90-710d-4ffa-9f9b-926d40ed446e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{chatsApiToken}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://{{projectID}}.texterchat.com/server/api/v2/chats/search","description":"Use this endpoint to search for chats based on various query parameters.
The most common use case is searching by the customer's phone number using the search query param.
Returns an object containing the total number of chats that match the query and an array of the corresponding chat objects.
\ndata - Array of chat objects matching the search criteria
total - Total number of chats found that match the query
Search by customer phone number
\n","type":"text/plain"},"key":"search","value":""},{"disabled":true,"description":{"content":"Filter by channel name. Must be used together with channel[accountId]
\n","type":"text/plain"},"key":"channel[name]","value":""},{"disabled":true,"description":{"content":"Filter by channel account ID. Must be used together with channel[name]
\n","type":"text/plain"},"key":"channel[accountId]","value":""},{"disabled":true,"description":{"content":"Filter chats by label ID. This parameter can be repeated to match multiple labels (e.g., label 1 or label 2 or label 3)
\n","type":"text/plain"},"key":"labels[]","value":""},{"disabled":true,"description":{"content":"Filter chats by CHAT_STATUS (BOT / PENDING / ASSIGNED / RESOLVED / BULK). This parameter can also be repeated to include multiple statuses, with the same behavior as labels[]
\n","type":"text/plain"},"key":"statuses[]","value":""},{"disabled":true,"description":{"content":"Whether to include chats with no messages. By default, only chats that contain messages are returned
\n","type":"text/plain"},"key":"showNoMessages","value":""},{"disabled":true,"description":{"content":"The maximum number of results to return
\n","type":"text/plain"},"key":"limit","value":""},{"disabled":true,"description":{"content":"The number of results to skip before starting to return records
\n","type":"text/plain"},"key":"skip","value":""}],"variable":[]}},"response":[{"id":"b8b44ff0-83b6-4e7c-a7ce-1296f73a9d3b","name":"Search by Phone","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{chatsApiToken}}","type":"text"}],"url":{"raw":"https://{{projectID}}.texterchat.com/server/api/v2/chats/search?search=0521234567","protocol":"https","host":["{{projectID}}","texterchat","com"],"path":["server","api","v2","chats","search"],"query":[{"key":"search","value":"0521234567","description":"Search by customer phone number"},{"key":"skip","value":"","description":"The number of results to skip before starting to return records","disabled":true},{"key":"limit","value":"","description":"The maximum number of results to return","disabled":true},{"key":"showNoMessages","value":"","description":"Whether to include chats with no messages. By default, only chats that contain messages are returned","disabled":true},{"key":"labels[]","value":"","description":"Filter chats by label ID. This parameter can be repeated to match multiple labels (e.g., label 1 or label 2 or label 3)","disabled":true},{"key":"statuses[]","value":"","description":"Filter chats by CHAT_STATUS. This parameter can also be repeated to include multiple statuses, with the same behavior as labels[]","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"_id\": \"67bf11038b24880cc966f799\",\n \"title\": \"John Doe\",\n \"agent\": {\n \"uid\": null,\n \"displayName\": \"\"\n },\n \"channel\": \"whatsapp\",\n \"entityPhone\": \"+972509876543\",\n \"clientPhoneE164\": \"+972521234567\",\n \"clientPhone\": \"+972521234567\",\n \"created\": \"2025-02-26T13:02:58.353Z\",\n \"botState\": {},\n \"last_message_timestamp\": 1762012091000,\n \"lastIncomingMessageTimestamp\": 1762012091000,\n \"status\": 3,\n \"unreadCount\": 6,\n \"channelInfo\": {\n \"name\": \"whatsapp\",\n \"id\": \"972521234567\",\n \"accountId\": \"972509876543\"\n },\n \"replyAction\": null,\n \"sendingBulkAgent\": null,\n \"departmentId\": null,\n \"pendingMessageTime\": null,\n \"pendingUpdateTime\": 1756292160,\n \"previousBotSession\": {\n \"latestAgentUid\": null,\n \"latestAgentName\": \"\",\n \"node\": \"resolved\",\n \"idleBotRetry\": null,\n \"flowVersion\": {\n \"identifier\": \"test-bot\",\n \"version\": 37\n },\n \"id\": \"99f3e9b18b6ae02781db30fb5fb673639d7007210a3280e87b754c44c3e6222c\",\n \"nodeState\": null,\n \"promptId\": \"1762011925691_681\",\n \"userState\": {\n \"whats_next\": {\n \"choice\": 2,\n \"text\": \"סגירת פנייה\",\n \"id\": \"סגירת פנייה\"\n }\n },\n \"failureNode\": \"agent_handoff\",\n \"lastBotMessage\": \"לא התקבלה תגובה, אתה עדיין שם?\",\n \"lastBotMessageTime\": \"2025-11-01T15:47:29.878Z\",\n \"promptChoiceResult\": 2,\n \"nodeInputRetries\": null\n },\n \"resolvedUpdateTime\": 1762012093,\n \"crmData\": {\n \"aiTerminateReason\": \"Inactivity\"\n },\n \"externalBot\": false,\n \"updatedAt\": \"2025-11-01T15:48:14.076Z\"\n }\n ],\n \"total\": 1\n}"},{"id":"6b741976-afda-4c54-ad97-5108bc9b41f5","name":"Search by Labels","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{chatsApiToken}}","type":"text"}],"url":{"raw":"https://{{projectID}}.texterchat.com/server/api/v2/chats/search?labels[]=VIP&labels[]=manager","protocol":"https","host":["{{projectID}}","texterchat","com"],"path":["server","api","v2","chats","search"],"query":[{"key":"search","value":"","description":"Search by customer phone number","disabled":true},{"key":"skip","value":"","description":"The number of results to skip before starting to return records","disabled":true},{"key":"limit","value":"","description":"The maximum number of results to return","disabled":true},{"key":"showNoMessages","value":"","description":"Whether to include chats with no messages. By default, only chats that contain messages are returned","disabled":true},{"key":"labels[]","value":"VIP","description":"Filter chats by label ID. This parameter can be repeated to match multiple labels (e.g., label 1 or label 2 or label 3)"},{"key":"statuses[]","value":"","description":"Filter chats by CHAT_STATUS. This parameter can also be repeated to include multiple statuses, with the same behavior as labels[]","disabled":true},{"key":"labels[]","value":"manager"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"_id\": \"67bf11028b24880cc966f799\",\n \"title\": \"Josh Dun\",\n \"agent\": {\n \"uid\": \"4d170fc7-5cd6-4496-98e4-f4f03a11456e\",\n \"displayName\": \"Tyler\"\n },\n \"channel\": \"whatsapp\",\n \"entityPhone\": \"+972509876543\",\n \"clientPhoneE164\": \"+972521234567\",\n \"clientPhone\": \"+972521234567\",\n \"created\": \"2025-02-26T13:02:58.353Z\",\n \"botState\": {},\n \"last_message_timestamp\": 1762196484000,\n \"lastIncomingMessageTimestamp\": 1762196484000,\n \"status\": 2,\n \"unreadCount\": 0,\n \"channelInfo\": {\n \"name\": \"whatsapp\",\n \"id\": \"972521234567\",\n \"accountId\": \"972509876543\"\n },\n \"replyAction\": null,\n \"sendingBulkAgent\": null,\n \"departmentId\": null,\n \"pendingMessageTime\": null,\n \"pendingUpdateTime\": 1762196423,\n \"previousBotSession\": {\n \"latestAgentUid\": null,\n \"latestAgentName\": \"\",\n \"node\": \"resolved\",\n \"idleBotRetry\": null,\n \"flowVersion\": {\n \"identifier\": \"Niv-test-bot\",\n \"version\": 37\n },\n \"id\": \"99f3e9b18b6ae02781db00fb5fb673639d7007210a3280e87b754c44c3e6222c\",\n \"nodeState\": null,\n \"promptId\": \"1762011925691_681\",\n \"userState\": {\n \"whats_next\": {\n \"choice\": 2,\n \"text\": \"סגירת פנייה\",\n \"id\": \"סגירת פנייה\"\n }\n },\n \"failureNode\": \"agent_handoff\",\n \"lastBotMessage\": \"לא התקבלה תגובה, אתה עדיין שם?\",\n \"lastBotMessageTime\": \"2025-11-01T15:47:29.878Z\",\n \"promptChoiceResult\": 2,\n \"nodeInputRetries\": null\n },\n \"resolvedUpdateTime\": 1762012093,\n \"crmData\": {\n \"aiTerminateReason\": \"Inactivity\"\n },\n \"externalBot\": false,\n \"updatedAt\": \"2025-11-03T19:02:17.849Z\",\n \"labels\": [\n \"VIP\"\n ]\n },\n {\n \"_id\": \"673209f9c921c35e04384da3\",\n \"title\": \"Gil Or\",\n \"agent\": {\n \"uid\": \"dbaa4322-ebd1-40ae-85ff-330ee2149ade\"\n },\n \"channel\": \"whatsapp\",\n \"entityPhone\": \"+972509876543\",\n \"clientPhoneE164\": \"+972541230987\",\n \"clientPhone\": \"+972541230987\",\n \"created\": \"2024-11-11T13:43:21.467Z\",\n \"botState\": {},\n \"last_message_timestamp\": 1762177887349,\n \"lastIncomingMessageTimestamp\": 1740589617000,\n \"status\": 2,\n \"unreadCount\": 0,\n \"channelInfo\": {\n \"name\": \"whatsapp\",\n \"id\": \"972541230987\",\n \"accountId\": \"972509876543\"\n },\n \"updatedAt\": \"2025-11-03T15:24:13.195Z\",\n \"replyAction\": null,\n \"sendingBulkAgent\": null,\n \"departmentId\": null,\n \"pendingMessageTime\": null,\n \"pendingUpdateTime\": 1762177778,\n \"previousBotSession\": {\n \"userState\": {\n \"ask_name\": {\n \"text\": \"Gi test\"\n },\n \"ask_issue_type\": {\n \"choice\": 1,\n \"text\": \"שינוי בוט\",\n \"id\": \"שינוי בוט\"\n },\n \"service_request_zapier\": {\n \"attempt\": \"01954339-d806-601a-0bc1-3da7653faed9\",\n \"id\": \"01954339-d806-601a-0bc1-3da7653faed9\",\n \"request_id\": \"01954339-d806-601a-0bc1-3da7653faed9\",\n \"status\": \"success\"\n }\n },\n \"nodeState\": null,\n \"node\": \"resolved\",\n \"lastBotMessage\": \"פרטיך נקלטו במערכת, מייד תענה\",\n \"lastBotMessageTime\": \"2025-02-26T17:06:59.515Z\",\n \"initText\": \"אשמח לפרטים\",\n \"flowVersion\": {\n \"identifier\": \"Niv-test-bot\",\n \"version\": 9\n },\n \"idleBotRetry\": null,\n \"id\": \"c6e9db952eaf3521477fd619cd2005ebf9dabf65e5f871381ac6089d5affacd4\",\n \"nodeInputRetries\": null,\n \"failureNode\": \"post_webhook_confirmation\"\n },\n \"hasMessageError\": false,\n \"crmData\": {\n \"send_to_make\": \"על פי המלל בפוליסה:\\nהצטרפות לביטוח ללא צורך במילוי הצהרת בריאות ניתן לבצע עבור עובדים חדשים תוך 120 ימים מיום תחילת העבודה. כאשר זוג חדש זכאי להצטרף ללא הצהרת בריאות תוך 120 ימים ממועד הנישואין. ניתן לצרף תינוק שנולד לעובד במהלך התקופה הקשורה להצטרפות לביטוח, באופן אוטומטי. עבור עובדים קיימים, אם עובד או בן משפחה מצטרף לפוליסה לאחר 120 ימים מתחילת ההסכם, הם יצטרכו למלא הצהרת בריאות. להעברת מבוטחים מפוליסה קודמת לפוליסה נוכחית נדרשת מצאת אסמכאת מתאימה. לגבי דמי הביטוח, העלות עבור כל מבוגר משתנה לפי קבוצת הגיל\",\n \"service_request_zapier\": {\n \"attempt\": \"01954339-d806-601a-0bc1-3da7653faed9\",\n \"id\": \"01954339-d806-601a-0bc1-3da7653faed9\",\n \"request_id\": \"01954339-d806-601a-0bc1-3da7653faed9\",\n \"status\": \"success\"\n }\n },\n \"resolvedUpdateTime\": 1740589620,\n \"labels\": [\n \"manager\"\n ]\n },\n {\n \"_id\": \"6846ab0170f86c4b25e53b87\",\n \"channelInfo\": {\n \"name\": \"whatsapp\",\n \"id\": \"972551472580\",\n \"accountId\": \"972509876543\"\n },\n \"agent\": {\n \"uid\": \"4d170fc7-5cd6-4496-98e4-f4f03a11456e\",\n \"displayName\": \"ניב\"\n },\n \"channel\": \"whatsapp\",\n \"clientPhone\": \"+972551472580\",\n \"clientPhoneE164\": \"+972551472580\",\n \"created\": \"2025-06-09T09:36:01.412Z\",\n \"entityPhone\": \"+972509876543\",\n \"lastIncomingMessageTimestamp\": 1761743254000,\n \"last_message_timestamp\": 1762168449225,\n \"status\": 2,\n \"title\": \"Texter Support\",\n \"unreadCount\": 4,\n \"updatedAt\": \"2025-11-03T19:00:17.369Z\",\n \"botState\": {},\n \"externalBot\": false,\n \"previousBotSession\": {\n \"latestAgentUid\": null,\n \"latestAgentName\": \"\",\n \"node\": \"resolved\",\n \"idleBotRetry\": 999,\n \"flowVersion\": {\n \"identifier\": \"Niv-test-bot\",\n \"version\": 37\n },\n \"id\": \"77d44b41e64bdaf1544d5a303c34587dde32766f58c1dac75d5e0354b797f0f3\",\n \"nodeState\": null,\n \"userState\": {},\n \"failureNode\": null,\n \"lastBotMessage\": \"לא התקבלה תגובה במשך זמן מה, הבוט נסגר. אם תצטרך עזרה נוספת, תוכל לפנות שוב מאוחר יותר.\",\n \"lastBotMessageTime\": \"2025-10-29T13:17:19.487Z\"\n },\n \"replyAction\": null,\n \"resolvedUpdateTime\": 1761743840,\n \"departmentId\": null,\n \"pendingMessageTime\": null,\n \"sendingBulkAgent\": null,\n \"pendingUpdateTime\": 1762196417,\n \"crmData\": {\n \"aiTerminateReason\": \"Error\",\n \"leadId\": 123072,\n \"leadName\": \"John Doe\"\n },\n \"hasMessageError\": true,\n \"labels\": [\n \"VIP\",\n \"error\",\n \"holiday\",\n \"manager\"\n ],\n \"blockTemplates\": true,\n \"unsubscribeTime\": 1762170503,\n \"unsubscribed\": {\n \"date\": \"2025-11-03T11:48:23.983Z\"\n }\n }\n ],\n \"total\": 3\n}"},{"id":"76cf3a24-665e-4f3c-af3c-3b25a4e8dd29","name":"Search by Status","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{chatsApiToken}}","type":"text"}],"url":{"raw":"https://{{projectID}}.texterchat.com/server/api/v2/chats/search?statuses[]=PENDING","protocol":"https","host":["{{projectID}}","texterchat","com"],"path":["server","api","v2","chats","search"],"query":[{"key":"search","value":"","description":"Search by customer phone number","disabled":true},{"key":"skip","value":"","description":"The number of results to skip before starting to return records","disabled":true},{"key":"limit","value":"","description":"The maximum number of results to return","disabled":true},{"key":"showNoMessages","value":"","description":"Whether to include chats with no messages. By default, only chats that contain messages are returned","disabled":true},{"key":"labels[]","value":"","description":"Filter chats by label ID. This parameter can be repeated to match multiple labels (e.g., label 1 or label 2 or label 3)","disabled":true},{"key":"statuses[]","value":"PENDING","description":"Filter chats by CHAT_STATUS. This parameter can also be repeated to include multiple statuses, with the same behavior as labels[]"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"_id\": \"672c8062f4273b63dae47e9f\",\n \"channelInfo\": {\n \"name\": \"messenger\",\n \"id\": \"9182340088450578\",\n \"accountId\": \"108851725349355\"\n },\n \"agent\": {\n \"uid\": \"\",\n \"displayName\": \"\"\n },\n \"channel\": \"messenger\",\n \"created\": \"2024-11-07T08:54:58.631Z\",\n \"image\": \"672c8062f4273b63dae47e98\",\n \"lastIncomingMessageTimestamp\": 1745321168942,\n \"last_message_timestamp\": 1745321174422,\n \"status\": 1,\n \"title\": \"Nenad Nash Radovanovic\",\n \"unreadCount\": 6,\n \"updatedAt\": \"2025-04-22T11:26:18.477Z\",\n \"botState\": {},\n \"pendingMessageTime\": 1745321174,\n \"pendingUpdateTime\": 1738922660,\n \"previousBotSession\": {\n \"flowVersion\": {\n \"identifier\": \"whatsper-bot\",\n \"version\": 14\n },\n \"idleBotRetry\": 999,\n \"id\": \"fb9b9b16a1714eda4070062da3b96182f2ce9dd6f56cc9c96baf93efc5c89597\",\n \"nodeState\": null,\n \"node\": \"handoff\",\n \"userState\": {},\n \"lastBotMessage\": \"I did not receive a response, so the request was closed.\\nYou can apply again at any time.\\nThank you and have a nice day.\",\n \"lastBotMessageTime\": \"2025-02-07T10:04:17.056Z\",\n \"failureNode\": null\n },\n \"departmentId\": null,\n \"replyAction\": null,\n \"sendingBulkAgent\": null\n }\n ],\n \"total\": 1\n}"},{"id":"364c3a95-1817-4f1c-a4f4-450dc0dd7de9","name":"Error Search Chats","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{chatsApiToken}}","type":"text"}],"url":{"raw":"https://{{projectID}}.texterchat.com/server/api/v2/chats/search?statuses[]=SOLVED","protocol":"https","host":["{{projectID}}","texterchat","com"],"path":["server","api","v2","chats","search"],"query":[{"key":"search","value":"","description":"Search by customer phone number","disabled":true},{"key":"skip","value":"","description":"The number of results to skip before starting to return records","disabled":true},{"key":"limit","value":"","description":"The maximum number of results to return","disabled":true},{"key":"showNoMessages","value":"","description":"Whether to include chats with no messages. By default, only chats that contain messages are returned","disabled":true},{"key":"labels[]","value":"","description":"Filter chats by label ID. This parameter can be repeated to match multiple labels (e.g., label 1 or label 2 or label 3)","disabled":true},{"key":"statuses[]","value":"SOLVED","description":"Filter chats by CHAT_STATUS. This parameter can also be repeated to include multiple statuses, with the same behavior as labels[]"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"data/statuses/0 must be equal to one of the allowed values\"\n}"}],"_postman_id":"5dd68f90-710d-4ffa-9f9b-926d40ed446e"},{"name":"Assign Chat","id":"44f07095-4ed1-4270-bf5b-6879c5c0907e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{chatsApiToken}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n // Require exactly one -\r\n \"phone\": \"Use this endpoint to assign a specific chat to a designated agent and/or department.
When a chat is assigned, its status is automatically set to PENDING for that specific agent and/or department.
Use this endpoint to change the status of a chat to RESOLVED. This action can be performed manually in Texter or via this endpoint.
\nWhile it does not depend on the current chat status, it is typically used once a human agent has finished the conversation. After a chat is resolved, any new incoming message from the customer will be routed back to the bot defined in Texter.
\nchatID - The unique identifier of the chat. You can obtain this value by using the Search Chats endpoint with the customer's phone number.Update the CRM data attached to a specific chat. Supports multiple merge strategies so you can fully replace, shallow merge, deep merge, or fill in missing fields.
\nchatID - The unique identifier of the chat. You can obtain this value by using the Search Chats endpoint with the customer's phone number.mergingMode ValuesReturns the updated chat object.
\n","urlObject":{"protocol":"https","path":["server","api","v2","chats","{{chatID}}","crm-data"],"host":["{{projectID}}","texterchat","com"],"query":[],"variable":[]}},"response":[{"id":"c626527d-735a-4c55-b3ac-549f9d30a73c","name":"Merge CRM Data (Default)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{chatsApiToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"data\": {\r\n \"plan\": \"premium\",\r\n \"tags\": [\"vip\", \"whale\"],\r\n \"customer\": {\r\n \"first_name\": \"Niv\",\r\n \"last_name\": \"Shteingart\",\r\n \"lead_id\": 641225\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{projectID}}.texterchat.com/server/api/v2/chats/{{chatID}}/crm-data"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"_id\": \"67a87067aeedqdee1271ck4d\",\n \"title\": \"Niv Shteingart\",\n \"channelInfo\": {\n \"name\": \"whatsapp\",\n \"id\": \"972521234567\",\n \"accountId\": \"972549876543\"\n },\n \"departmentId\": null,\n \"agent\": {\n \"uid\": null,\n \"displayName\": \"\"\n },\n \"status\": 0,\n \"created\": \"2025-05-07T11:09:03.295Z\",\n \"updatedAt\": \"2026-01-15T14:22:10.123Z\",\n \"lastIncomingMessageTimestamp\": 1762200310000,\n \"lastMessage\": {\n \"type\": \"text\",\n \"text\": \"Hello!\"\n },\n \"unreadCount\": 0,\n \"crmData\": {\n \"plan\": \"premium\",\n \"tags\": [\"vip\", \"whale\"],\n \"customer\": {\n \"first_name\": \"Niv\",\n \"last_name\": \"Shteingart\",\n \"lead_id\": 641225\n }\n },\n \"lastMessageTimestamp\": 1762200315209\n}"},{"id":"26e5bf5f-5f06-42f9-a117-7009f0820069","name":"Replace CRM Data","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{chatsApiToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"data\": {\r\n \"customerId\": \"CRM-9001\",\r\n \"tier\": \"gold\"\r\n },\r\n \"mergingMode\": \"replace\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{projectID}}.texterchat.com/server/api/v2/chats/{{chatID}}/crm-data"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"_id\": \"67a87067aeedqdee1271ck4d\",\n \"title\": \"Niv Shteingart\",\n \"channelInfo\": {\n \"name\": \"whatsapp\",\n \"id\": \"972521234567\",\n \"accountId\": \"972549876543\"\n },\n \"departmentId\": null,\n \"agent\": {\n \"uid\": null,\n \"displayName\": \"\"\n },\n \"status\": 0,\n \"created\": \"2025-05-07T11:09:03.295Z\",\n \"updatedAt\": \"2026-01-15T14:25:00.000Z\",\n \"lastIncomingMessageTimestamp\": 1762200310000,\n \"lastMessage\": {\n \"type\": \"text\",\n \"text\": \"Hello!\"\n },\n \"unreadCount\": 0,\n \"crmData\": {\n \"customerId\": \"CRM-9001\",\n \"tier\": \"gold\"\n },\n \"lastMessageTimestamp\": 1762200315209\n}"},{"id":"965286c4-886f-4621-828a-69df02c48ba3","name":"Fill Missing Keys (defaults)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{chatsApiToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"data\": {\r\n \"customerId\": \"CRM-9001\",\r\n \"source\": \"website\"\r\n },\r\n \"mergingMode\": \"defaults\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{projectID}}.texterchat.com/server/api/v2/chats/{{chatID}}/crm-data"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"_id\": \"67a87067aeedqdee1271ck4d\",\n \"title\": \"Niv Shteingart\",\n \"channelInfo\": {\n \"name\": \"whatsapp\",\n \"id\": \"972521234567\",\n \"accountId\": \"972549876543\"\n },\n \"departmentId\": null,\n \"agent\": {\n \"uid\": null,\n \"displayName\": \"\"\n },\n \"status\": 0,\n \"created\": \"2025-05-07T11:09:03.295Z\",\n \"updatedAt\": \"2026-01-15T14:28:00.000Z\",\n \"lastIncomingMessageTimestamp\": 1762200310000,\n \"lastMessage\": {\n \"type\": \"text\",\n \"text\": \"Hello!\"\n },\n \"unreadCount\": 0,\n \"crmData\": {\n \"customerId\": \"CRM-9001\",\n \"source\": \"website\"\n },\n \"lastMessageTimestamp\": 1762200315209\n}"},{"id":"08b36e74-3071-4b61-8467-c1063586c7d0","name":"Error - Chat Not Found","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{chatsApiToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"data\": {\r\n \"plan\": \"premium\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{projectID}}.texterchat.com/server/api/v2/chats/invalidChatID/crm-data"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Chat invalidChatID not found\"\n}"}],"_postman_id":"ff807883-4f01-4a9c-8863-e6b0119e3a67"},{"name":"Update Chat Properties","id":"1238b009-50cd-4be3-959f-3ea84c009d67","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{chatsApiToken}}"}]},"isInherited":false},"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n // Any of -\r\n \"displayName\": \"Use this endpoint to modify various attributes of a chat. Its most commonly used to change customer's display name in Texter or to enable/disable an external bot for the chat.
\nNote that updating properties fully overrides any existing values. For example, if a crmData object already exists, it will be fully replaced by the new object provided in the request.
\nIf you want to merge crmData, use the endpoint Update CRM Data instead.
\nchatID - The unique identifier of the chat. You can obtain this value by using the Search Chats endpoint with the customer's phone number.On a successfull call this will return the updated chat object.
\n","urlObject":{"protocol":"https","path":["server","api","v2","chats","{{chatID}}"],"host":["{{projectID}}","texterchat","com"],"query":[],"variable":[]}},"response":[{"id":"e1d95026-fe8b-4bd2-9e07-6f35256eabc2","name":"Update External Bot","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{chatsApiToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"externalBot\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{projectID}}.texterchat.com/server/api/v2/chats/{{chatID}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"_id\": \"67a87067aeedqdee1271ck4d\",\n \"title\": \"Josh Dun\",\n \"agent\": {\n \"uid\": \"4d170fc7-5cd6-4496-98e4-f4f03a11456e\",\n \"displayName\": \"Tyler Joesph\"\n },\n \"channel\": \"whatsapp\",\n \"entityPhone\": \"+972509876543\",\n \"clientPhoneE164\": \"+972521234567\",\n \"clientPhone\": \"+972521234567\",\n \"lastText\": \"image\",\n \"created\": \"2025-02-26T13:02:58.353Z\",\n \"botState\": {},\n \"last_message_timestamp\": 1762196484000,\n \"lastIncomingMessageTimestamp\": 1762196484000,\n \"status\": 3,\n \"unreadCount\": 0,\n \"channelInfo\": {\n \"name\": \"whatsapp\",\n \"id\": \"972521234567\",\n \"accountId\": \"972509876543\"\n },\n \"lastMessage\": {\n \"type\": \"media\",\n \"media\": [\n {\n \"fileId\": \"6908fc09962e17ab3033fa13\",\n \"mediaType\": \"image\",\n \"contentType\": \"image/jpeg\"\n }\n ],\n \"forwarded\": false\n },\n \"replyAction\": null,\n \"sendingBulkAgent\": null,\n \"departmentId\": null,\n \"pendingMessageTime\": null,\n \"pendingUpdateTime\": 1762196423,\n \"previousBotSession\": {},\n \"resolvedUpdateTime\": 1762202519,\n \"crmData\": {\n \"aiTerminateReason\": \"Inactivity\"\n },\n \"externalBot\": true,\n \"updatedAt\": \"2025-11-03T20:41:59.246Z\",\n \"labels\": [\n \"VIP\"\n ]\n}"},{"id":"44a08437-f329-4567-b990-c1f18f118ef8","name":"Update Crm Data","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{chatsApiToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"crmData\": {\r\n \"age\": 18,\r\n \"email\": \"johnd1@gmail.com\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{projectID}}.texterchat.com/server/api/v2/chats/{{chatID}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"_id\": \"67a87067aeedqdee1271ck4d\",\n \"title\": \"Josh Dun\",\n \"agent\": {\n \"uid\": \"4d170fc7-5cd6-4496-98e4-f4f03a11456e\",\n \"displayName\": \"Tyler Joesph\"\n },\n \"channel\": \"whatsapp\",\n \"entityPhone\": \"+972509876543\",\n \"clientPhoneE164\": \"+972521234567\",\n \"clientPhone\": \"+972521234567\",\n \"lastText\": \"image\",\n \"created\": \"2025-02-26T13:02:58.353Z\",\n \"botState\": {},\n \"last_message_timestamp\": 1762196484000,\n \"lastIncomingMessageTimestamp\": 1762196484000,\n \"status\": 3,\n \"unreadCount\": 0,\n \"channelInfo\": {\n \"name\": \"whatsapp\",\n \"id\": \"972521234567\",\n \"accountId\": \"972509876543\"\n },\n \"lastMessage\": {\n \"type\": \"media\",\n \"media\": [\n {\n \"fileId\": \"6908fc09962e17ab3033fa13\",\n \"mediaType\": \"image\",\n \"contentType\": \"image/jpeg\"\n }\n ],\n \"forwarded\": false\n },\n \"replyAction\": null,\n \"sendingBulkAgent\": null,\n \"departmentId\": null,\n \"pendingMessageTime\": null,\n \"pendingUpdateTime\": 1762196423,\n \"previousBotSession\": {},\n \"resolvedUpdateTime\": 1762202519,\n \"crmData\": {\n \"age\": 18,\n \"email\": \"johnd1@gmail.com\"\n },\n \"externalBot\": true,\n \"updatedAt\": \"2025-11-03T20:46:59.246Z\",\n \"labels\": [\n \"VIP\"\n ]\n}"},{"id":"51f92317-3d3b-4a42-8419-9fa542f51456","name":"Update Multiple Properties","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{chatsApiToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"displayName\": \"Donald J. Trump\",\r\n \"crmDeepLink\": \"https://texterchat.com/\",\r\n \"externalBot\": false\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{projectID}}.texterchat.com/server/api/v2/chats/{{chatID}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"_id\": \"67a87067aeedqdee1271ck4d\",\n \"title\": \"Donald\",\n \"displayName\": \"Donald J. Trump\",\n \"agent\": {\n \"uid\": null,\n \"displayName\": \"\"\n },\n \"channel\": \"whatsapp\",\n \"entityPhone\": \"+972509876543\",\n \"clientPhoneE164\": \"+972521234567\",\n \"clientPhone\": \"+972521234567\",\n \"lastText\": \"לא התקבלה תגובה, אתה עדיין שם?\",\n \"created\": \"2025-02-26T13:02:58.353Z\",\n \"botState\": {\n \"latestAgentUid\": \"4d170fc7-5cd6-4496-98e4-f4f03a11456e\",\n \"latestAgentName\": \"ניב\",\n \"node\": \"whats_next\",\n \"idleBotRetry\": 1,\n \"flowVersion\": {\n \"identifier\": \"Niv-test-bot\",\n \"version\": 37\n },\n \"id\": \"e1f5eb5c7cbd3181bc6ebc012e012bf9cd992055e7ec968aa63519fbb7b75b36\",\n \"nodeState\": \"in_progress\",\n \"promptId\": \"1762202585929_468\",\n \"userState\": {},\n \"failureNode\": \"agent_handoff\",\n \"lastBotMessage\": \"לא התקבלה תגובה, אתה עדיין שם?\",\n \"lastBotMessageTime\": \"2025-11-03T20:47:08.761Z\"\n },\n \"last_message_timestamp\": 1762202829601,\n \"lastIncomingMessageTimestamp\": 1762196484000,\n \"status\": 0,\n \"unreadCount\": 0,\n \"channelInfo\": {\n \"name\": \"whatsapp\",\n \"id\": \"972521234567\",\n \"accountId\": \"972509876543\"\n },\n \"lastMessage\": {\n \"type\": \"text\",\n \"text\": \"לא התקבלה תגובה, אתה עדיין שם?\"\n },\n \"replyAction\": null,\n \"sendingBulkAgent\": null,\n \"departmentId\": null,\n \"pendingMessageTime\": null,\n \"pendingUpdateTime\": 1762196423,\n \"previousBotSession\": {},\n \"resolvedUpdateTime\": 1762202519,\n \"crmData\": {\n \"age\": 18,\n \"email\": \"johnd1@gmail.com\"\n },\n \"externalBot\": false,\n \"updatedAt\": \"2025-11-03T20:47:09.703Z\",\n \"labels\": [\n \"VIP\"\n ],\n \"crmDeepLink\": \"https://texterchat.com/\"\n}"},{"id":"fa972e93-2d44-4d23-a7ae-d6a455428246","name":"Error Update Chat","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{chatsApiToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"displayName\": \"Nivvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{projectID}}.texterchat.com/server/api/v2/chats/{{chatID}}"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"data/title must NOT have more than 255 characters\"\n}"}],"_postman_id":"1238b009-50cd-4be3-959f-3ea84c009d67"}],"id":"2d66b2c4-d64a-4dd1-b244-9cc3b2828424","description":"This section contains all endpoints related to retrieving, searching, and managing chats within Texter.
\nYou can use these endpoints to fetch chat details, search for existing conversations, update chat properties, assign or resolve chats, and manage their associated metadata.
\nGenerate a token with the following scopes:
\nManage All Chats
\nList All Chats
\nResolve Chat
\nSend Session Message
\nAnd store it in chatsApiToken
Use this endpoint to retrieve a list of all labels that are defined in Texter.
\nThe response contains a labels array, where each item is a label object with id, name, and color properties.
It also includes a total field indicating the total number of labels returned.
The number of results to skip before starting to return records
\n","type":"text/plain"},"key":"skip","value":""},{"disabled":true,"description":{"content":"The maximum number of results to return
\n","type":"text/plain"},"key":"limit","value":""}],"variable":[]}},"response":[{"id":"e25c2131-019f-43c2-8e0b-576e2d8dcd7d","name":"Get All Labels","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{labelsApiToken}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{{projectID}}.texterchat.com/server/api/v2/labels","protocol":"https","host":["{{projectID}}","texterchat","com"],"path":["server","api","v2","labels"],"query":[{"key":"skip","value":"","description":"The number of results to skip before starting to return records","disabled":true},{"key":"limit","value":"","description":"The maximum number of results to return","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"total\": 6,\n \"labels\": [\n {\n \"id\": \"hp-high-priority\",\n \"name\": \"High Priority\",\n \"color\": \"#F47373\"\n },\n {\n \"id\": \"hot_lead\",\n \"name\": \"HOT LEAD\",\n \"color\": \"#2CCCE4\"\n },\n {\n \"id\": \"VIP\",\n \"name\": \"VIP\",\n \"color\": \"#dce775\"\n },\n {\n \"id\": \"holiday\",\n \"name\": \"הטבת קמפיין סוכות\",\n \"color\": \"#123456\"\n },\n {\n \"id\": \"manager\",\n \"name\": \"מנהל\",\n \"color\": \"#37D67A\"\n },\n {\n \"id\": \"failed_message\",\n \"name\": \"שליחה נכשלה\",\n \"color\": \"#e80303\"\n }\n ]\n}"},{"id":"21c27144-a3e0-4eb7-9b44-cae83d34fe80","name":"Error Get All Labels","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{labelsApiToken}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{{projectID}}.texterchat.com/server/api/v2/labels?skip=200000","protocol":"https","host":["{{projectID}}","texterchat","com"],"path":["server","api","v2","labels"],"query":[{"key":"skip","value":"200000","description":"The number of results to skip before starting to return records"},{"key":"limit","value":"","description":"The maximum number of results to return","disabled":true}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"skip: Invalid value. Should be a positive integer less than 100000\"\n}"}],"_postman_id":"5f5b0c4f-7be7-48f7-8f7c-2eb46f827c92"},{"name":"Get Label Data","id":"76dc5490-0e73-4612-b7cd-5046a4d305ba","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{labelsApiToken}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://{{projectID}}.texterchat.com/server/api/v2/labels/{{labelID}}","description":"Use this endpoint to fetch the full details of a specific label by providing its unique label ID.
\nlabelID - The unique identifier of the label you want to retrieve.The response returns a single label object containing its id, name, and color.
Use this endpoint to create a new label in Texter.
\nThe response returns the newly created label object, including its id, name, and color.
Use this endpoint to manage labels for a specific chat. You can perform one of three actions: add, remove, or set labels (based on their IDs).
Using set will override any existing labels on the chat and replace them with the new list you provide.
chatID - The unique identifier of the chat. You can obtain this value by using the Search Chats endpoint with the customer's phone number.Use this endpoint to update the details of an existing label. You can modify the label’s name or color, but not its id.
\nlabelID - The unique identifier of the label you want to update.Use this endpoint to permanently delete a label from Texter.
\nlabelID - The unique identifier of the label you want to delete.This section contains all endpoints related to creating, updating, and managing labels in Texter.
\nYou can use these endpoints to create and edit labels, assign or remove them from chats, retrieve label data, or delete labels entirely from your inbox.
\nGenerate a token with the following scopes:
\nManage All Chats
\nManage Labels
\nAnd store it in labelsApiToken
Use this endpoint to retrieve a list of all current channel health problems. You can apply various filters, such as by severity or by specific account, etc.
This endpoint is useful for monitoring system health and diagnosing issues that may affect messaging performance.
The response contains a problems array with problem objects and a total field that indicates the number of problems returned.
The problems are sorted by createdAt in ascending order.
Also include already resolved problems records
\n","type":"text/plain"},"key":"includeResolved","value":""},{"disabled":true,"description":{"content":"Filter by problem severity (warning / error)
\n","type":"text/plain"},"key":"severity","value":""},{"disabled":true,"description":{"content":"Affected channel account ID
\n","type":"text/plain"},"key":"accountId","value":""},{"disabled":true,"description":{"content":"How many results to skip
\n","type":"text/plain"},"key":"skip","value":""},{"disabled":true,"description":{"content":"Max results to return
\n","type":"text/plain"},"key":"limit","value":""},{"disabled":true,"description":{"content":"Channel type name (whatsapp / messenger / instagram / website_chat / email)
\n","type":"text/plain"},"key":"channel","value":""}],"variable":[]}},"response":[{"id":"fc328bf3-fce6-406e-93b5-e993e852b08a","name":"All \"Error\" Level Problems","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{channelsApiToken}}","type":"text"}],"url":{"raw":"https://{{projectID}}.texterchat.com/server/api/v2/channels/health/problems?severity=error","protocol":"https","host":["{{projectID}}","texterchat","com"],"path":["server","api","v2","channels","health","problems"],"query":[{"key":"includeResolved","value":"","description":"Also include already resolved problems records","disabled":true},{"key":"severity","value":"error","description":"Filter by problem severity"},{"key":"accountId","value":"","description":"Affected channel account ID","disabled":true},{"key":"skip","value":"","description":"How many results to skip","disabled":true},{"key":"limit","value":"","description":"Max results to return","disabled":true},{"key":"channel","value":"","description":"Channel type name","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"total\": 1,\n \"problems\": [\n {\n \"_id\": \"68be7a16475a76a869de5987\",\n \"accountId\": \"972509876543\",\n \"channel\": \"whatsapp\",\n \"createdAt\": 1757313558371,\n \"impairedFunctionality\": {\n \"send\": false,\n \"receive\": false\n },\n \"message\": \"WhatsApp app ID is not set\",\n \"name\": \"whatsapp_app_id_error\",\n \"severity\": \"error\"\n }\n ]\n}"},{"id":"850f4d6d-f2f7-4dea-ba4f-38ceb52c99d2","name":"Channel Problems & Resolved","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{channelsApiToken}}","type":"text"}],"url":{"raw":"https://{{projectID}}.texterchat.com/server/api/v2/channels/health/problems?includeResolved=true&channel=whatsapp","protocol":"https","host":["{{projectID}}","texterchat","com"],"path":["server","api","v2","channels","health","problems"],"query":[{"key":"includeResolved","value":"true","description":"Also include already resolved problems records"},{"key":"severity","value":"","description":"Filter by problem severity","disabled":true},{"key":"accountId","value":"","description":"Affected channel account ID","disabled":true},{"key":"skip","value":"","description":"How many results to skip","disabled":true},{"key":"limit","value":"","description":"Max results to return","disabled":true},{"key":"channel","value":"whatsapp","description":"Channel type name"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"total\": 3,\n \"problems\": [\n {\n \"_id\": \"67fe17ee90e28dd18b9f330e\",\n \"channel\": \"whatsapp\",\n \"accountId\": \"972509876543\",\n \"name\": \"Message Delivery Delay\",\n \"severity\": \"warning\",\n \"impairedFunctionality\": {\n \"send\": true,\n \"receive\": false,\n \"contactPhoneNumber\": true\n },\n \"message\": \"Observed delays in message delivery on WhatsApp.\",\n \"instruction\": \"Verify server connection and check message queues.\",\n \"createdAt\": 1680000000000,\n \"startedAt\": 1680000100000,\n \"resolvedAt\": 1758447847018\n },\n {\n \"_id\": \"67fe17ee90e28dd18b9f3313\",\n \"channel\": \"whatsapp\",\n \"accountId\": \"972509876543\",\n \"name\": \"Attachment Upload Failure\",\n \"severity\": \"warning\",\n \"impairedFunctionality\": {\n \"attachments\": true,\n \"send\": true\n },\n \"message\": \"Attachments fail to upload on WhatsApp messages.\",\n \"instruction\": \"Check file size limits and network stability.\",\n \"createdAt\": 1680500000000,\n \"resolvedAt\": 1745324531457\n },\n {\n \"_id\": \"688bc5f30c36e71b1d8cdb4a\",\n \"accountId\": \"972541346790\",\n \"channel\": \"whatsapp\",\n \"createdAt\": 1753990643507,\n \"impairedFunctionality\": {\n \"send\": false,\n \"receive\": false\n },\n \"message\": \"WhatsApp app ID is not set\",\n \"name\": \"whatsapp_app_id_error\",\n \"severity\": \"error\",\n \"resolvedAt\": 1757313440790\n }\n ]\n}"},{"id":"3cb21430-72a7-4b9a-ad60-4a403faba6e3","name":"Error Get Channel Health Problems","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{channelsApiToken}}","type":"text"}],"url":{"raw":"https://{{projectID}}.texterchat.com/server/api/v2/channels/health/problems?channel=facebook","protocol":"https","host":["{{projectID}}","texterchat","com"],"path":["server","api","v2","channels","health","problems"],"query":[{"key":"includeResolved","value":"","description":"Also include already resolved problems records","disabled":true},{"key":"severity","value":"","description":"Filter by problem severity","disabled":true},{"key":"accountId","value":"","description":"Affected channel account ID","disabled":true},{"key":"skip","value":"","description":"How many results to skip","disabled":true},{"key":"limit","value":"","description":"Max results to return","disabled":true},{"key":"channel","value":"facebook","description":"Channel type name"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"data/channel must be equal to one of the allowed values\"\n}"}],"_postman_id":"b6ccef3f-5186-427f-95e2-7b844ea5a31a"},{"name":"Resolve Channel Health Problem","id":"f467b6fa-8b55-4806-9d43-85ef3acc3b05","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{channelsApiToken}}"}]},"isInherited":false},"method":"POST","header":[],"url":"https://{{projectID}}.texterchat.com/server/api/v2/channels/health/problems/{{problemID}}/resolve","description":"Use this endpoint to mark a specific channel health problem as resolved in Texter. Once resolved, the problem will no longer appear in active health problem listings.
\nproblemID - The unique identifier of the problem you want to resolve. You can obtain the problem ID by first calling the List Channel Health Problems endpoint.This section contains all endpoints related to monitoring and maintaining the health of connected messaging channels.
\nYou can use these endpoints to retrieve active channel health problems, filter them by severity or account, and mark specific issues as resolved once addressed.
\nGenerate a token with the following scopes:
\nAnd store it in channelsApiToken
Use this endpoint to generate a public URL for a media file stored in Texter.
\nThe generated link provides read-only access and remains valid according to the TTL (time-to-live) specified in the request, if provided. If no TTL is specified, the link does not expire.
\nGenerating a new link does not override existing ones - multiple public URLs can coexist for the same file.
\nfileID - This can be obtained from the media[].fileId field within a message object, which you can retrieve using the Get Messages of a Chat endpoint.The response includes a token and a url field. The url is a public link that incorporates the token and can be used to access the file until it expires.
This section contains the endpoint for generating public access links to media files stored in Texter.
\nGenerate a token with the following scopes:
\nView All Files
\nView All Chats
\nAnd store it in filesApiToken
Retrieve a list of all existing event subscriptions and scenarios in Texter.
All subsription scenarios will start with the prefix \"(SUB)\" in their name.
Returns an object containing the total number of scenarios that match the query and an array of the corresponding scenario objects.
\nscenarios - Array of scenario objects matching the search criteria
total - Total number of scenarios found that match the query
The number of results to skip before starting to return records
\n","type":"text/plain"},"key":"skip","value":null},{"disabled":true,"description":{"content":"The maximum number of results to return
\n","type":"text/plain"},"key":"limit","value":null},{"disabled":true,"description":{"content":"Return only scenarios having one of these triggers in active revision
\n","type":"text/plain"},"key":"triggerEvents[]","value":null},{"disabled":true,"description":{"content":"Return only scenarios with active revision
\n","type":"text/plain"},"key":"onlyActive","value":""},{"disabled":true,"description":{"content":"Return only scenarios created by this user
\n","type":"text/plain"},"key":"draftsAuthor","value":null},{"disabled":true,"description":{"content":"Sort the scenarios by modified time
\n","type":"text/plain"},"key":"sortLatestModified","value":null},{"disabled":true,"description":{"content":"Sort the scenarios by activated time
\n","type":"text/plain"},"key":"sortLatestActivated","value":null}],"variable":[]}},"response":[],"_postman_id":"4f1e41a3-707c-47da-8c85-a91c1c53e983"},{"name":"Inactivate Subscription","id":"59946f95-6527-43ca-8cd3-d0a9742eb97e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{scenariosApiToken}}"}]},"isInherited":false},"method":"POST","header":[],"url":"https://{{projectID}}.texterchat.com/server/api/v2/scenarios/manage/{{scenarioID}}/revisions/inactivate","description":"Pause a subscription. The scenario remains in your account but will stop triggering webhooks until reactivated
\nscenarioID - The unique identifier of the subscription. You can use the List All Subscriptions endpoint to get the relevant scenario ID under scenarios[]._idReturns the new scenario object
\n","urlObject":{"protocol":"https","path":["server","api","v2","scenarios","manage","{{scenarioID}}","revisions","inactivate"],"host":["{{projectID}}","texterchat","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"59946f95-6527-43ca-8cd3-d0a9742eb97e"},{"name":"Activate Subscription","id":"83509784-e2e8-4d4e-adbd-876520e8379c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{scenariosApiToken}}"}]},"isInherited":false},"method":"POST","header":[],"url":"https://{{projectID}}.texterchat.com/server/api/v2/scenarios/manage/{{scenarioID}}/revisions/{{scenarioVersion}}/activate","description":"Resume a paused subscription or revert to a specific version of the scenario
\nscenarioID - The unique identifier of the subscription. You can use the List All Subscriptions endpoint to get the relevant scenario ID under scenarios[]._id
scenarioVersion - The scenario version to activate. Can be found under scenarios[].inactiveRevisions[].version
Returns the new scenario object
\n","urlObject":{"protocol":"https","path":["server","api","v2","scenarios","manage","{{scenarioID}}","revisions","{{scenarioVersion}}","activate"],"host":["{{projectID}}","texterchat","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"83509784-e2e8-4d4e-adbd-876520e8379c"},{"name":"Delete Subscription","id":"61ab173b-eff6-46cb-9994-8bc6a5760d7c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{scenariosApiToken}}"}]},"isInherited":false},"method":"DELETE","header":[],"url":"https://{{projectID}}.texterchat.com/server/api/v2/scenarios/manage/{{scenarioID}}","description":"Permanently remove a subscription and all its history
\nscenarioID - The unique identifier of the subscription. You can use the List All Subscriptions endpoint to get the relevant scenario ID under scenarios[]._id204 No Content (Empty body) on success
Subscribe to receive notifications to your specified webhook URL for each new message event. This includes both incoming and outgoing messages.
\nThe request body is pre-configured to capture message and chat data. You only need to modify the following specific fields within the JSON body:
\nurl (Required): Located under data.actions[0].params.url. You must replace the placeholder {{yourWebhookURL}} with the actual destination URL where you want to receive the events.
asStatus: Located at the root. Keep this \"active\" to enable the subscription immediately, or \"inactive\" to save it as an inactive revision.
When an event triggers, your webhook URL will receive a POST request.
The payload structure contains an eventName (set to newMessage) and an eventData object containing the specific resource details.
message: The message object
chat: The chat object the message belongs to
Example Payload received by your Webhook:
\n{\n \"eventName\": \"newMessage\",\n \"eventData\": {\n \"message\": {\n \"_id\": \"64de3b15398a8o09c47a9f62\",\n \"text\": \"Hello world\",\n \"direction\": \"outgoing\",\n ...\n },\n \"chat\": {\n \"_id\": \"69062b15262e17ab3033f886\",\n \"displayName\": \"Tyler Joseph\",\n ...\n }\n }\n}\n\nSubscribe to receive notifications to your specified webhook URL for each new incoming message event. This excludes outgoing messages.
\nThe request body is pre-configured to capture message and chat data. You only need to modify the following specific fields within the JSON body:
\nurl (Required): Located under data.actions[0].params.url. You must replace the placeholder {{yourWebhookURL}} with the actual destination URL where you want to receive the events.
asStatus: Located at the root. Keep this \"active\" to enable the subscription immediately, or \"inactive\" to save it as an inactive revision.
When an event triggers, your webhook URL will receive a POST request.
The payload structure contains an eventName (set to newIncomingMessage) and an eventData object containing the specific resource details.
message: The incoming message object
chat: The chat object the message belongs to
Example Payload received by your Webhook:
\n{\n \"eventName\": \"newIncomingMessage\",\n \"eventData\": {\n \"message\": {\n \"_id\": \"64de3b15398a8o09c47a9f62\",\n \"text\": \"Hey, can someone call me back?\",\n \"direction\": \"incoming\",\n ...\n },\n \"chat\": {\n \"_id\": \"69062b15262e17ab3033f886\",\n \"displayName\": \"Josh Dun\",\n ...\n }\n }\n}\n\nSubscribe to receive notifications to your specified webhook URL whenever a new incoming message matches specific text criteria. This allows you to filter events based on keywords, phrases, or complex logic.
\nThe request body is pre-configured to capture message and chat data. You need to modify the url and define your matching logic in the expression field:
url (Required): Located under data.actions[0].params.url. You must replace the placeholder {{yourWebhookURL}} with the actual destination URL where you want to receive the events.
expression (Required): Located under data.conditions[0][1].params.expression. You must replace the placeholder logic with your specific matching criteria using the syntax text == \"your keyword\".
Single Keyword: \"text == \\\"help\\\"\"
Multiple Keywords (OR): \"text == \\\"buy\\\" or text == \\\"purchase\\\"\"
Complex Logic: Supports and, or, not, and parentheses ().
\"(text == \\\"urgent\\\" and text == \\\"error\\\") or text == \\\"critical\\\"\"Whole Sentences: Matches the exact string. \"text == \\\"I want to speak to a human\\\"\"
asStatus: Located at the root. Keep this \"active\" to enable the subscription immediately, or \"inactive\" to save it as an inactive revision.
When an event triggers (i.e., a message arrives that matches your expression), your webhook URL will receive a POST request.
The payload structure contains an eventName (set to newMatchedMessage) and an eventData object containing the specific resource details.
message: The incoming message object
chat: The chat object the message belongs to
Example Payload received by your Webhook:
\n{\n \"eventName\": \"newMatchedMessage\",\n \"eventData\": {\n \"message\": {\n \"_id\": \"64de3b15398a8o09c47a9f62\",\n \"text\": \"I need help with my billing\",\n \"direction\": \"incoming\",\n ...\n },\n \"chat\": {\n \"_id\": \"69062b15262e17ab3033f886\",\n \"displayName\": \"Niv Shtein\",\n ...\n }\n }\n}\n\nSubscribe to receive notifications to your specified webhook URL whenever a new incoming message contains a media attachment. This triggers for images, videos, audio files, documents, or stickers.
\nThe request body is pre-configured to capture message and chat data, and filters specifically for messages where type == \"media\". You only need to modify the following fields:
url (Required): Located under data.actions[0].params.url. You must replace the placeholder {{yourWebhookURL}} with the actual destination URL where you want to receive the events.
asStatus: Located at the root. Keep this \"active\" to enable the subscription immediately, or \"inactive\" to save it as an inactive revision.
When an event triggers, your webhook URL will receive a POST request.
The payload structure contains an eventName (set to newMediaMessage) and an eventData object containing the specific resource details.
message: The incoming message object. This will contain the media details.
chat: The chat object the message belongs to.
Example Payload received by your Webhook:
\n{\n \"eventName\": \"newMediaMessage\",\n \"eventData\": {\n \"message\": {\n \"_id\": \"64de3b15398a8o09c47a9f62\",\n \"type\": \"media\",\n \"media\": [\n {\n \"mediaType\": \"image\",\n \"caption\": \"how much does it cost?\",\n \"fileId\": \"696325cb1bc02c8a8a9f383a\",\n \"filename\": \"image.png\"\n }\n ],\n \"direction\": \"incoming\",\n ...\n },\n \"chat\": {\n \"_id\": \"69062b15262e17ab3033f886\",\n \"displayName\": \"Noa Yoter\",\n ...\n }\n }\n}\n\nSubscribe to receive notifications to your specified webhook URL whenever an outgoing message fails to deliver (e.g., blocked by Meta/WhatsApp, invalid number, or network failure).
\nThe request body is pre-configured to capture status requests where the status indicates failure (Codes 4 or 5). You only need to modify the following specific fields:
\nurl (Required): Located under data.actions[0].params.url. You must replace the placeholder {{yourWebhookURL}} with the actual destination URL where you want to receive the events.
asStatus: Located at the root. Keep this \"active\" to enable the subscription immediately, or \"inactive\" to save it as an inactive revision.
When an event triggers, your webhook URL will receive a POST request.
The payload structure contains an eventName (set to messageFailed) and an eventData object containing the failure details.
chat: The chat object associated with the failed message.
error: The error message or code received from the provider.
timestamp: The timestamp (Unix Epoch milliseconds) when the failure occurred.
externalId: An array of unique IDs assigned to the message(s) by the external provider (e.g., WhatsApp).
Because this event is triggered by the external provider (e.g., Meta/WhatsApp), the payload does not contain the internal message._id. Instead, it provides the externalId.
To find the specific message details within your system:
\nTake the _id from the chat object in the payload.
Use the Get Messages of a Chat endpoint.
\nFilter the results to find the message where its channelInfo.id matches one of the values in the externalId array received in this webhook.
Example Payload received by your Webhook:
\n{\n \"eventName\": \"messageFailed\",\n \"eventData\": {\n \"chat\": {\n \"_id\": \"69072b0233aea8a47f8bad9f\",\n \"hasMessageError\": true,\n \"title\": \"972521234567\",\n ...\n },\n \"error\": \"Message undeliverable\\nMessage Undeliverable.\",\n \"timestamp\": 1768141074000,\n \"externalId\": [\n \"wamid.HBgMOTcyNTIxMjM0NTY3FQIAERgSMDhGRTVGNEY1MTA0Q0NBMzNEAA==\"\n ]\n }\n}\n\nSubscribe to receive notifications to your specified webhook URL whenever the status of an outgoing message changes. This allows you to track the lifecycle of a message (e.g., \"Sent\" to \"Delivered\" to \"Seen\").
\nThe request body is pre-configured to capture all status change events. You only need to modify the following specific fields:
\nurl (Required): Located under data.actions[0].params.url. You must replace the placeholder {{yourWebhookURL}} with the actual destination URL where you want to receive the events.
asStatus: Located at the root. Keep this \"active\" to enable the subscription immediately, or \"inactive\" to save it as an inactive revision.
When an event triggers, your webhook URL will receive a POST request.
The payload structure contains an eventName (set to messageStatusChanged) and an eventData object containing the status details.
chat: The chat object associated with the message.
messageStatus: An integer representing the new status. See the Status Codes below.
error: The error message (only present if status is 4 or 5, otherwise null).
timestamp: The timestamp (Unix Epoch milliseconds) when the status changed.
externalId: An array of unique IDs assigned to the message(s) by the external provider (e.g., WhatsApp).
The messageStatus field will contain one of the following integer values:
0 - Sent: Message sent from the platform.
\n1 - Accepted: Accepted by the provider (e.g., Meta received it).
\n2 - Delivered: Delivered to the recipient's device.
\n3 - Seen: Read/Opened by the recipient (Blue ticks).
\n4 - Failed: Failed to deliver (e.g., invalid number).
\n5 - Channel Failed: System/Channel level failure.
\n6 - Deleted: Message was deleted.
\nBecause this event is triggered by the external provider (e.g., Meta/WhatsApp), the payload does not contain the internal message._id. Instead, it provides the externalId.
To find the specific message details within your system:
\nTake the _id from the chat object in the payload.
Use the Get Messages of a Chat endpoint.
\nFilter the results to find the message where its channelInfo.id matches one of the values in the externalId array received in this webhook.
Example Payload received by your Webhook:
\n{\n \"eventName\": \"messageStatusChanged\",\n \"eventData\": {\n \"chat\": {\n \"_id\": \"69072b0233aea8a47f8bad9f\",\n \"displayName\": \"Josh Dun\",\n \"channelInfo\": {\n \"name\": \"whatsapp\",\n \"id\": \"972521234567\"\n },\n ...\n },\n \"messageStatus\": 3,\n \"error\": null,\n \"timestamp\": 1768141074000,\n \"externalId\": [\n \"wamid.HBgMOTcyNTIxMjM0NTY3FQIAERgSMDhGRTVGNEY1MTA0Q0NBMzNEAA==\"\n ]\n }\n}\n\nSubscribe to receive notifications to your specified webhook URL when a chat unsubscribes from template messages - for example when the customer sends an opt-out keyword such as \"הסר\" or when an agent in Texter manually unsubcribes the chat.
\nThe request body is pre-configured to capture chat data. You only need to modify the following specific fields within the JSON body:
\nurl (Required): Located under data.actions[0].params.url. You must replace the placeholder {{yourWebhookURL}} with the actual destination URL where you want to receive the events.
asStatus: Located at the root. Keep this \"active\" to enable the subscription immediately, or \"inactive\" to save it as an inactive revision.
When an event triggers, your webhook URL will receive a POST request.
The payload structure contains an eventName (set to chatUnsubscribed) and an eventData object containing the specific resource details.
chat: The chat object for the conversation that unsubscribed. When this event fires, the chat typically includes template-unsubscribe metadata such as unsubscribed.date and unsubscribed.bulkSendId (see the Chat Object reference).Example Payload received by your Webhook:
\n{\n \"eventName\": \"chatUnsubscribed\",\n \"eventData\": {\n \"chat\": {\n \"_id\": \"69062b15262e17ab3033f886\",\n \"displayName\": \"Tyler Joseph\",\n \"unsubscribed\": {\n \"date\": \"2025-10-30T21:01:48.989Z\",\n \"bulkSendId\": \"97337f16-e717-4ac9-b2dd-8552909b9252\"\n },\n ...\n }\n }\n}\n\nSubscribe to receive notifications to your specified webhook URL when a chat subscribes or opts back in to template messages.
\nThe request body is pre-configured to capture chat data. You only need to modify the following specific fields within the JSON body:
\nurl (Required): Located under data.actions[0].params.url. Replace the placeholder {{yourWebhookURL}} with the URL that should receive the events.
asStatus: Located at the root. Use \"active\" to enable the subscription immediately, or \"inactive\" to save an inactive revision.
When the event fires, your webhook receives a POST with JSON:
\neventName: chatSubscribed
eventData.chat: The chat object for the conversation.
Example:
\n{\n \"eventName\": \"chatSubscribed\",\n \"eventData\": {\n \"chat\": {\n \"_id\": \"69062b15262e17ab3033f886\",\n \"title\": \"Tyler Joseph\",\n \"...\"\n }\n }\n}\n\nSubscribe to receive notifications to your specified webhook URL when a chat is taken by an agent.
\nThe request body is pre-configured to capture chat and agent data. You only need to modify the following specific fields within the JSON body:
\nurl (Required): Located under data.actions[0].params.url. You must replace the placeholder {{yourWebhookURL}} with the actual destination URL where you want to receive the events.
asStatus: Located at the root. Keep this \"active\" to enable the subscription immediately, or \"inactive\" to save it as an inactive revision.
When an event triggers, your webhook URL will receive a POST request.
The payload structure contains an eventName (set to chatAssigned) and an eventData object containing the specific resource details.
chat: The chat object
agent: A narrowed agent object with id, crmId, email, displayName, and roles
Example Payload received by your Webhook:
\n{\n \"eventName\": \"chatAssigned\",\n \"eventData\": {\n \"chat\": {\n \"_id\": \"69062b15262e17ab3033f886\",\n \"displayName\": \"Josh Dun\",\n ...\n },\n \"agent\": {\n \"id\": \"333aed7a-b3ea-4e5c-acbc-d8499be509c3\",\n \"crmId\": \"alex1999\",\n \"email\": \"agent@example.com\",\n \"displayName\": \"Alex\",\n \"roles\": [\"admin\"]\n }\n }\n}\n\nThe Subscribe to Events API allows you to register webhooks for specific events occurring in your Texter environment.
\nUnder the hood, this system utilizes Scenarios - a workflow automation type feature within Texter. However, to make integration easy, we provide pre-defined templates. You simply \"Import\" a scenario JSON (which we provide in the sub-folders below), plug in your webhook url, and the subscription is active.
\nOn top of importing the scenario, provided below are several endpoints to help you manage your subscriptions.
\nIf the provided template events don't satisfy your needs, please contact the Texter Support team and we'd gladly help modify any triggers/conditions/actions needed for your webhook.
\nGenerate a token with the following scopes:
\nView Scenarios
\nCreate Scenarios
\nDelete Scenarios
\nActivate/Inactivate Scenarios
\nManage Scenarios on behalf of User
\nAnd store it in scenariosApiToken
The activeRevision and items inside inactiveRevisions follow this structure. It represents a specific snapshot of the scenario logic.
-
\n-
\n-
\n-
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{quickRepliesApiToken}}"}]},"isInherited":true,"source":{"_postman_id":"400f1a24-b0ff-4e01-ae6f-7f171a149794","id":"400f1a24-b0ff-4e01-ae6f-7f171a149794","name":"Quick Replies - Coming Soon","type":"folder"}},"urlObject":{"protocol":"https","path":["server","api","v2","quick-replies"],"host":["{{projectID}}","texterchat","com"],"query":[{"disabled":true,"description":{"content":"How many results to skip
\n","type":"text/plain"},"key":"skip","value":""},{"disabled":true,"description":{"content":"Max results to return
\n","type":"text/plain"},"key":"limit","value":""},{"disabled":true,"description":{"content":"Sort alphabetically by display.title
\n","type":"text/plain"},"key":"sortTitle","value":""},{"disabled":true,"description":{"content":"Sort by metadata.created
\n","type":"text/plain"},"key":"sortCreated","value":""},{"disabled":true,"description":{"content":"Sort by metadata.updated
\n","type":"text/plain"},"key":"sortUpdated","value":""},{"disabled":true,"description":{"content":"Channel type name
\n","type":"text/plain"},"key":"forChat.name","value":""},{"disabled":true,"description":{"content":"Channel accound ID
\n","type":"text/plain"},"key":"forChat.accountId","value":""},{"disabled":true,"description":{"content":"Specific chat ID
\n","type":"text/plain"},"key":"forChat.id","value":""},{"disabled":true,"description":{"content":"Filter by display position
\n","type":"text/plain"},"key":"position","value":""},{"disabled":true,"description":{"content":"Only quick-replies that include at least one message of the listed content types
\n","type":"text/plain"},"key":"hasContentsType","value":"['text', 'media', 'contacts', 'location', 'buttons', 'list', 'postback', 'special']"}],"variable":[]}},"response":[],"_postman_id":"89770251-3e66-47be-9f86-725c25428960"},{"name":"Create Quick Reply","id":"23ac2b82-32d1-4374-987b-af2e9913f351","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"send\": {\r\n \"contents\": [\r\n { /* MessageContents object */ }\r\n ],\r\n \"betweenMessagesDelay\": 1000, // Delay in ms\r\n \"target\": [\r\n {\r\n \"name\": \"-
\n-
\n-
\n-
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{quickRepliesApiToken}}"}]},"isInherited":true,"source":{"_postman_id":"400f1a24-b0ff-4e01-ae6f-7f171a149794","id":"400f1a24-b0ff-4e01-ae6f-7f171a149794","name":"Quick Replies - Coming Soon","type":"folder"}},"urlObject":{"protocol":"https","path":["server","api","v2","quick-replies"],"host":["{{projectID}}","texterchat","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"23ac2b82-32d1-4374-987b-af2e9913f351"},{"name":"Update Existing Quick Reply","id":"303b6793-0688-4cb5-ab55-1824ce478558","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"url":"https://{{projectID}}.texterchat.com/server/api/v2/quick-replies/{{quickReplyID}}","description":"-
\n-
\n-
\n-
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{quickRepliesApiToken}}"}]},"isInherited":true,"source":{"_postman_id":"400f1a24-b0ff-4e01-ae6f-7f171a149794","id":"400f1a24-b0ff-4e01-ae6f-7f171a149794","name":"Quick Replies - Coming Soon","type":"folder"}},"urlObject":{"protocol":"https","path":["server","api","v2","quick-replies","{{quickReplyID}}"],"host":["{{projectID}}","texterchat","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"303b6793-0688-4cb5-ab55-1824ce478558"},{"name":"Delete Quick Reply","id":"f213cf08-5ead-4c4a-92a7-3819164327c4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://{{projectID}}.texterchat.com/server/api/v2/quick-replies/{{quickReplyID}}","description":"-
\n-
\n-
\n-
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{quickRepliesApiToken}}"}]},"isInherited":true,"source":{"_postman_id":"400f1a24-b0ff-4e01-ae6f-7f171a149794","id":"400f1a24-b0ff-4e01-ae6f-7f171a149794","name":"Quick Replies - Coming Soon","type":"folder"}},"urlObject":{"protocol":"https","path":["server","api","v2","quick-replies","{{quickReplyID}}"],"host":["{{projectID}}","texterchat","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"f213cf08-5ead-4c4a-92a7-3819164327c4"}],"id":"400f1a24-b0ff-4e01-ae6f-7f171a149794","description":"Coming Soon...
\nGenerate a token with the following scopes:
\nAnd store it in quickRepliesApiToken