Directly control and create new objects in your Hitrate dialer instance using our APIs.
Automate workflows or extract order or customer data directly to your other platforms with our simple to use APIs.
Each request needs to be made with a bearer token.
Tokens can be generated by either admins or users with \"manage token\" permission in each dialer. The tokens inherit the permissions from the user they belong to. One token per user per dialer.
An API token is tied to a user and inherits all the permission the user has. In the case a permission is lacking the API response will consist of a JSON body with the message key which states which permissions are missing.
\nSecondly if a user belongs to a office that is limited, they will only be able to see objects in the API that belongs to their own office. When a limited user creates things in the dailer or new objects through the API, they all iinherit the user's office automatically. Users who aren't limited need to assign new items to an office. Some things aren't explicitly tied to an office, they inherit their office assignment through contactlist, campaign, or the customer.
\n200 – success
Request made correctly
400 - bad request
Your request body has some form of syntax error in it
401- unauthenticated
Missing token or request is outside the scope for your token.
Tokens match your permissions as a user in each dialer instance, if this is the error contact your dialer admin.
404 – page not found
URL is wrong or API is deprecated, refer to the documentation.
413 - request entity too large
\nThe dialer has a request limit on 10MB payloads, if larger split up the requests.
\n500 – server error
Server is offline or errors with the request, such as missing mandatory field.
Each dialer has its own instance, meaning a unique url. To access your specific dialer you need to change the start of the request to match whichever dialer the API should be directed towards, followed with \":3007\".
Example: the dialer \"demodailer\" requests would start with \"https://demodailer.hitrate.tech:3007\".
For the examples we'll be using the \"QA\" dialer,
\nDownload calls as mp3
\nNew concept: clients. Easier manage and track campaigns & products based on which client owns a campaign/product.
\nAPIs for managing clients
\nNew call result, recurring order, which allows agents to easier track customers that need to be called again before an order is signed.
\nUpdate order status/cancel/verify in same endpoint
\nCancel orders
\nBlocklist blocking numbers for a set duration of time
\nDeletion of blocklists
\nDelete number on blocklist
\nSearching for sms sent between customer and dailer
\nExporting sms history as PDF
\nSms templates can be tied to offices. Affects GET/POST/PUT
\nGET /api/customer GDPR deleted customers will return Not found instead of a customer with data deleted.
\nGET /api/customer now includes all calls that belong to the customer.
\nGET /api/users and GET /api/user/:id now includes which role the users has.
\nGET /api/sms_templates/sms_tokens updated to reflect the new sms string replacements.
\nCreates a new search for calls based on the provided criteria. Only calls the user who owns the API token have access to can be listed here.
\nLimit and page can be used to batch the results in different pages. Internal max limit is 50000 calls, anything above this will not be sent through API.
\nPhonenumber needs to be in E164 format, leading \"+\" is optional.
\nCalls with recording = true has a recording tied to it, /api/call/:id/recording can be used to download it.
\nSupported values for \"type\":
\n\"predictive\" - Call on predictive campaign
\n\"automatic\" - Call on automatic campaign
\n\"incoming\" - Incoming call on any campaign
\n\"batch_call\" - Call on batch_call campaign
\n\"click-to-call\" - Call on click-to-call campaign
\n\"click\" - Manual callback on a customer card the user doesn't own
\n\"retry\" - Callback on customer card before previous call is saved
\n\"callback\" - Manual callback on a customer card the user owns
\nGet more detalied information about a call.
\nid - Id for the call itself\nphonenumber - Called number, this might differ from the customers current number if it's been changed\ncallerid - Number the dialer used to call the customer\ncustomer_id - Id of the customer\ncustomer_firstname - Name of customer\ncustomer_lastname - Name of customer\nuser_id - User/agent who was in the call\nuser - Name of user/agent\ninit_time - Timestamp when the call started\nconnect_time - Timestamp for when the call connected\nfinish_time - Timestamp for when the call finished\nhandling_end - Timestamp for when the customer card was closed\ncall_result_id - Id for the call result\ncampaign_id - Id for which the campaign the call took place\ntype - What type of call this call was, see documentation above for more info\nhas_recording - Boolean for if the call has a recording\ncall_length_in_seconds - Length of the call\n\nWhat call to fetch information on
\n","type":"text/plain"},"type":"any","value":"call_id","key":"id"}]}},"response":[{"id":"3ae26d07-cb62-449c-a36a-e406c228b9e1","name":"Response types","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{your_dialer}.hitrate.tech:3007/api/call/:id","host":["{your_dialer}.hitrate.tech"],"port":"3007","path":["api","call",":id"],"variable":[{"key":"id","value":"3658","description":"What call to fetch information on"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"430"},{"key":"etag","value":"W/\"1ae-vDtXxhet0yWEbB8Dpuq/iT6t79w\""},{"key":"date","value":"Wed, 09 Jul 2025 11:08:20 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": int,\n \"phonenumber\": string,\n \"callerid\": string\",\n \"customer_id\": int,\n \"customer_firstname\": string,\n \"customer_lastname\": string,\n \"user_id\": int,\n \"user\": string,\n \"init_time\": datetime,\n \"connect_time\": datetime,\n \"finish_time\": datetime,\n \"handling_end\": datetime,\n \"call_result_id\": int,\n \"campaign_id\": int,\n \"type\": string, //predictive/automatic/click-to-call/incoming/batch_call/retry/callback\n \"has_recording\": boolean,\n \"call_length_in_seconds\": int\n}"},{"id":"0f02b199-9fe2-46ea-9e1a-9a480ef68db9","name":"Call found","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"https://{your_dialer}.hitrate.tech:3007/api/call/:id","protocol":"https","host":["{your_dialer}.hitrate.tech"],"port":"3007","path":["api","call",":id"],"variable":[{"key":"id","value":"4371"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"441"},{"key":"etag","value":"W/\"1b9-c1AIQitRD8czzOiL3+C6u2O2AG4\""},{"key":"date","value":"Thu, 31 Oct 2024 11:50:14 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 4371,\n \"phonenumber\": \"46424424312\",\n \"callerid\": \"+46542505216\",\n \"customer_id\": null,\n \"customer_firstname\": null,\n \"customer_lastname\": null,\n \"user_id\": 14,\n \"user\": \"David Bärnsten\",\n \"init_time\": \"2024-09-30T10:50:34.000Z\",\n \"connect_time\": \"2024-09-30T10:50:39.000Z\",\n \"finish_time\": \"2024-09-30T10:51:15.000Z\",\n \"handling_end\": \"2024-09-30T10:56:59.000Z\",\n \"call_result_id\": 70,\n \"campaign_id\": 23,\n \"type\": \"callback\",\n \"has_recording\": true,\n \"call_length_in_seconds\": 36\n}"},{"id":"00fea13b-1676-4702-b7db-474cc3468a96","name":"Call not found","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"https://{your_dialer}.hitrate.tech:3007/api/call/:id","protocol":"https","host":["{your_dialer}.hitrate.tech"],"port":"3007","path":["api","call",":id"],"variable":[{"key":"id","value":"43713"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"28"},{"key":"etag","value":"W/\"1c-zCXJc4Qt6LTLot5KR8YaqahVRCw\""},{"key":"date","value":"Thu, 31 Oct 2024 11:49:57 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Call not found\"\n}"}],"_postman_id":"4f8d90e6-f0e0-4b0c-811c-e9bfb9d51e65"},{"name":"Download call","id":"bfc53b0d-aef0-4b3a-8eec-8b58ecf9dc4b","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true},"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{API token}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{your_dialer}.hitrate.tech:3007/api/call/:id/recording?mp3=boolean","description":"Download the call recording for the matching call.
\nAPI response is raw recording file in wav format to either be downloaded, transcribed, or otherwise.
\nStandard format is .wav for the recordings, mp3 is an option if mp3 is set as 1 in query parameter.
\n","urlObject":{"port":"3007","path":["api","call",":id","recording"],"host":["{your_dialer}.hitrate.tech"],"query":[{"key":"mp3","value":"boolean"}],"variable":[{"description":{"content":"Call to download recording from
\n","type":"text/plain"},"type":"any","value":"call_id","key":"id"}]}},"response":[{"id":"4ec926a7-e53d-430b-8818-b427ee533c76","name":"Call recording not found","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"https://{your_dialer}.hitrate.tech:3007/api/call/:id/recording","protocol":"https","host":["{your_dialer}.hitrate.tech"],"port":"3007","path":["api","call",":id","recording"],"variable":[{"key":"id","value":"43713"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"23"},{"key":"etag","value":"W/\"17-JG2JTE6to/D4sxc2pRx7Kk+opAc\""},{"key":"date","value":"Thu, 31 Oct 2024 11:49:06 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Not found\"\n}"}],"_postman_id":"bfc53b0d-aef0-4b3a-8eec-8b58ecf9dc4b"},{"name":"Call customer","id":"b6ccbab5-b5cc-4c3f-aa6d-341f678882ce","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true},"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{API token}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"agent\" : int,\r\n \"campaign_id\" : int,\r\n \"allow_calling_finalized\" : boolean,\r\n \"customer_id\": int\r\n \"phonenumber\": string\r\n}","options":{"raw":{"language":"json"}}},"url":"{your_dialer}.hitrate.tech:3007/api/customer/call","description":"Starts a call and brings up related customer card for agent.
\nIn order for a call to start, the agent need to:
\nBe connected to the dialer
\nNot in a call
\nHave access to the campaign
\nIf allow_calling_finalized is set to false, then customer can't have any no, loss, or order call result
\nCustomer_id OR phonenumber is needed. Customer_id takes priority over phonenumber if both are included.
\n","urlObject":{"port":"3007","path":["api","customer","call"],"host":["{your_dialer}.hitrate.tech"],"query":[],"variable":[]}},"response":[{"id":"5470859c-345d-4026-b42a-9f369f5a33aa","name":"Response types","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"agent\" : 14,\r\n \"campaign_id\" : 2,\r\n \"allow_calling_finalized\" : true,\r\n \"phonenumber\": \"4676xxxxxxx\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{your_dialer}.hitrate.tech:3007/api/customer/call"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"149"},{"key":"etag","value":"W/\"95-bzh/OP1tAoZ+K0SIzjOEI6jxM8o\""},{"key":"date","value":"Fri, 24 Jan 2025 08:49:01 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": string,\n \"return_object\": {\n \"campaign_id\": int,\n \"call_now\": boolean,\n \"phonenumber\": string,\n \"on_customer_404_create\": boolean\n }\n}"},{"id":"f4300601-de5d-45b2-b527-3c4a210eacea","name":"Successful call","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"agent\" : 14,\r\n \"campaign_id\" : 2,\r\n \"allow_calling_finalized\" : true,\r\n \"phonenumber\": \"4676xxxxxxx\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{your_dialer}.hitrate.tech:3007/api/customer/call"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"149"},{"key":"etag","value":"W/\"95-bzh/OP1tAoZ+K0SIzjOEI6jxM8o\""},{"key":"date","value":"Fri, 24 Jan 2025 08:49:01 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Call triggered successfully\",\n \"return_object\": {\n \"campaign_id\": 2,\n \"call_now\": true,\n \"phonenumber\": \"46768085162\",\n \"on_customer_404_create\": true\n }\n}"},{"id":"f0ba7da1-be1b-4998-ad0a-1e988744dc60","name":"Customer already finalized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"agent\" : 14,\r\n \"campaign_id\" : 2,\r\n \"allow_calling_finalized\" : false,\r\n \"phonenumber\": \"4676xxxxxxx\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{your_dialer}.hitrate.tech:3007/api/customer/call"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"40"},{"key":"etag","value":"W/\"28-R4LM73WI5sm2P5uaCB44ul9TGgw\""},{"key":"date","value":"Fri, 24 Jan 2025 08:51:10 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Customer has result: Unknown\"\n}"},{"id":"341999c3-ad0b-4ea3-beb3-1b543469fc51","name":"Error - agent is not available","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"agent\" : 14,\r\n \"campaign_id\" : 2,\r\n \"allow_calling_finalized\" : true,\r\n \"phonenumber\": \"4676xxxxxxx\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{your_dialer}.hitrate.tech:3007/api/customer/call"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"48"},{"key":"etag","value":"W/\"30-SH9V/UsbwHpzD9VZdGToVX9Ipa8\""},{"key":"date","value":"Fri, 24 Jan 2025 08:49:31 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Agent is not available to take calls\"\n}"},{"id":"9ce73b9e-b310-48e3-a64f-928796bc331d","name":"Error - invalid phonenumber","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"agent\" : 14,\r\n \"campaign_id\" : 2,\r\n \"allow_calling_finalized\" : true,\r\n \"phonenumber\": \"467643242348083\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{your_dialer}.hitrate.tech:3007/api/customer/call"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"32"},{"key":"etag","value":"W/\"20-Eiu6eJXbL/J9aCzCywhE+1vmN4M\""},{"key":"date","value":"Fri, 24 Jan 2025 08:50:28 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Invalid phone number\"\n}"},{"id":"c5d35177-dd43-4563-866a-b3e10a511fd0","name":"Error - campaign doesn't exist","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"agent\" : 102,\r\n \"campaign_id\" : 192,\r\n \"allow_calling_finalized\" : true,\r\n \"customer_id\": 2934641\r\n}","options":{"raw":{"language":"json"}}},"url":"{your_dialer}.hitrate.tech:3007/api/customer/call"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"30"},{"key":"etag","value":"W/\"1e-voKWibn04/SkpMxzKQABP3t4uas\""},{"key":"date","value":"Fri, 24 Jan 2025 08:50:47 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Campaign not found\"\n}"}],"_postman_id":"b6ccbab5-b5cc-4c3f-aa6d-341f678882ce"},{"name":"Get call results","id":"07da670d-e95a-4cea-b33c-f9394b77a8dc","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true},"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{API token}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{your_dialer}.hitrate.tech:3007/api/call_results","description":"Lists all call results that exists on the dialer, including stanard call results that the dialer uses when making predictive/automatic calls.
\nThere are 5 base types of call results that decide how a customer gets handeled:
\nRetry_flag: Bit map parameter that decides how the customer should be called again. Retry type can be combined with each other, but it's generally recommeded to only use one to avoid confusion for agents.
\n1: Private callback - agent can see this under \"my recurring calls\" & the recurring widget. Manual.
\n2: Public callback - all agents can see this under \"public recurring\". Manual.
\n4: Dialer callback - the dialer will call this customer again. Automatic.
\nRetry: Expressed in amount of minutes until the next call should take place.
\nPick_date: Allows agents to change/pick the date for when the customer should be called next time.
\nNote: Only recurring and order recurring call results need these extra parameters. And all parameters are option except for retry_flag.
\n","urlObject":{"port":"3007","path":["api","call_results"],"host":["{your_dialer}.hitrate.tech"],"query":[],"variable":[]}},"response":[{"id":"aa40eda9-3356-4209-935b-192f5ef5fba7","name":"Response types","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{your_dialer}.hitrate.tech:3007/api/call_results"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"3177"},{"key":"etag","value":"W/\"c69-zJoGBIkTxyu654Fbeb2W0w15Q6k\""},{"key":"date","value":"Fri, 24 Jan 2025 09:11:39 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": boolean,\n \"call_results\": [\n {\n \"id\": int,\n \"type\": string,\n \"type_id\": int,\n \"title\": string,\n \"retry\": int,\n \"pick_date\": int,\n \"retry_flags\": int\n }\n ]\n}"},{"id":"5421853f-577e-4f70-8f34-b63723384738","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{your_dialer}.hitrate.tech:3007/api/call_results"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"3177"},{"key":"etag","value":"W/\"c69-zJoGBIkTxyu654Fbeb2W0w15Q6k\""},{"key":"date","value":"Fri, 24 Jan 2025 09:11:39 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"call_results\": [\n {\n \"id\": 1,\n \"type\": \"Recurring\",\n \"type_id\": 4,\n \"title\": \"Answering machine\",\n \"retry\": null,\n \"pick_date\": 0,\n \"retry_flags\": null\n },\n {\n \"id\": 2,\n \"type\": \"Recurring\",\n \"type_id\": 4,\n \"title\": \"Recurring - Dialer\",\n \"retry\": null,\n \"pick_date\": 0,\n \"retry_flags\": null\n },\n {\n \"id\": 3,\n \"type\": \"Recurring\",\n \"type_id\": 4,\n \"title\": \"Number does not exists\",\n \"retry\": \"1440\",\n \"pick_date\": 0,\n \"retry_flags\": null\n },\n {\n \"id\": 4,\n \"type\": \"Loss\",\n \"type_id\": 2,\n \"title\": \"Loss\",\n \"retry\": null,\n \"pick_date\": 0,\n \"retry_flags\": null\n },\n {\n \"id\": 5,\n \"type\": \"Order\",\n \"type_id\": 1,\n \"title\": \"Order\",\n \"retry\": null,\n \"pick_date\": 0,\n \"retry_flags\": null\n },\n {\n \"id\": 6,\n \"type\": null,\n \"type_id\": null,\n \"title\": \"Complementary call\",\n \"retry\": null,\n \"pick_date\": 0,\n \"retry_flags\": null\n },\n {\n \"id\": 7,\n \"type\": \"Recurring\",\n \"type_id\": 4,\n \"title\": \"Can not be reached\",\n \"retry\": null,\n \"pick_date\": 0,\n \"retry_flags\": null\n },\n {\n \"id\": 8,\n \"type\": \"Recurring\",\n \"type_id\": 4,\n \"title\": \"Overcall\",\n \"retry\": null,\n \"pick_date\": 0,\n \"retry_flags\": null\n },\n {\n \"id\": 9,\n \"type\": \"Recurring\",\n \"type_id\": 4,\n \"title\": \"No answer\",\n \"retry\": null,\n \"pick_date\": 0,\n \"retry_flags\": null\n },\n {\n \"id\": 10,\n \"type\": \"Recurring\",\n \"type_id\": 4,\n \"title\": \"Busy\",\n \"retry\": null,\n \"pick_date\": 0,\n \"retry_flags\": null\n },\n {\n \"id\": 11,\n \"type\": \"Recurring\",\n \"type_id\": 4,\n \"title\": \"Call disconnected\",\n \"retry\": null,\n \"pick_date\": 0,\n \"retry_flags\": null\n },\n {\n \"id\": 12,\n \"type\": \"Loss\",\n \"type_id\": 2,\n \"title\": \"Wrong number\",\n \"retry\": null,\n \"pick_date\": 0,\n \"retry_flags\": null\n },\n {\n \"id\": 13,\n \"type\": \"Recurring\",\n \"type_id\": 4,\n \"title\": \"Upcoming\",\n \"retry\": \"1\",\n \"pick_date\": 1,\n \"retry_flags\": 1\n },\n {\n \"id\": 14,\n \"type\": \"Recurring\",\n \"type_id\": 4,\n \"title\": \"Blacklisted\",\n \"retry\": null,\n \"pick_date\": 0,\n \"retry_flags\": 0\n },\n {\n \"id\": 15,\n \"type\": \"Loss\",\n \"type_id\": 2,\n \"title\": \"Maximum number of attempts\",\n \"retry\": null,\n \"pick_date\": 0,\n \"retry_flags\": 0\n },\n {\n \"id\": 16,\n \"type\": \"Loss\",\n \"type_id\": 2,\n \"title\": \"Time block recurring private\",\n \"retry\": null,\n \"pick_date\": 0,\n \"retry_flags\": null\n },\n {\n \"id\": 17,\n \"type\": \"Loss\",\n \"type_id\": 2,\n \"title\": \"Time block recurring public\",\n \"retry\": null,\n \"pick_date\": 0,\n \"retry_flags\": null\n },\n {\n \"id\": 18,\n \"type\": null,\n \"type_id\": null,\n \"title\": \"Missed incoming call\",\n \"retry\": null,\n \"pick_date\": 0,\n \"retry_flags\": null\n },\n {\n \"id\": 19,\n \"type\": \"Recurring\",\n \"type_id\": 4,\n \"title\": \"Missed incoming call recurring\",\n \"retry\": null,\n \"pick_date\": 0,\n \"retry_flags\": null\n },\n {\n \"id\": 20,\n \"type\": \"Loss\",\n \"type_id\": 2,\n \"title\": \"Maximum number of answering machines\",\n \"retry\": null,\n \"pick_date\": 0,\n \"retry_flags\": 0\n },\n {\n \"id\": 21,\n \"type\": null,\n \"type_id\": null,\n \"title\": \"External forward\",\n \"retry\": null,\n \"pick_date\": 0,\n \"retry_flags\": null\n },\n {\n \"id\": 22,\n \"type\": \"No thanks\",\n \"type_id\": 3,\n \"title\": \"Custom no call result\",\n \"retry\": null,\n \"pick_date\": 0,\n \"retry_flags\": 0\n },\n {\n \"id\": 26,\n \"type\": \"Loss\",\n \"type_id\": 2,\n \"title\": \"Custom loss result\",\n \"retry\": null,\n \"pick_date\": 0,\n \"retry_flags\": null\n },\n {\n \"id\": 30,\n \"type\": \"Recurring\",\n \"type_id\": 4,\n \"title\": \"Custom recurring call - dailer call again 24 hours\",\n \"retry\": \"1440\",\n \"pick_date\": 0,\n \"retry_flags\": 4\n },\n {\n \"id\": 34,\n \"type\": \"Recurring\",\n \"type_id\": 4,\n \"title\": \"Custom recurring call - dailer call again agent picks time\",\n \"retry\": \"1440\",\n \"pick_date\": 1,\n \"retry_flags\": 4\n },\n {\n \"id\": 38,\n \"type\": \"Recurring\",\n \"type_id\": 4,\n \"title\": \"Custom recurring call - callback public\",\n \"retry\": null,\n \"pick_date\": 1,\n \"retry_flags\": 2\n },\n {\n \"id\": 42,\n \"type\": \"Recurring\",\n \"type_id\": 4,\n \"title\": \"Custom recurring call - private callback\",\n \"retry\": null,\n \"pick_date\": 1,\n \"retry_flags\": 1\n }\n ]\n}"}],"_postman_id":"07da670d-e95a-4cea-b33c-f9394b77a8dc"},{"name":"Get call result","id":"f09cd1a7-b99c-4793-8f97-1ede8eba9fa4","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true},"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{API token}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{your_dialer}.hitrate.tech:3007/api/call_result/:id","description":"Get information on a specific call result, see Get call results for more info.
\n","urlObject":{"port":"3007","path":["api","call_result",":id"],"host":["{your_dialer}.hitrate.tech"],"query":[],"variable":[{"id":"73cce3bb-fc7e-453b-a790-3818831f89e7","type":"any","value":"","key":"id"}]}},"response":[{"id":"3b4e2ca8-dc29-4a65-bf3c-5d1c0f7b932a","name":"Response types","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{your_dialer}.hitrate.tech:3007/api/call_result/34"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"185"},{"key":"etag","value":"W/\"b9-jLj+o+PPd6fAK+aZcjYGnPV8hpM\""},{"key":"date","value":"Fri, 24 Jan 2025 09:16:08 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": boolean,\n \"call_results\": {\n \"id\": int,\n type\": string,\n \"type_id\": int,\n \"title\": string,\n \"retry\": int,\n \"pick_date\": int,\n \"retry_flags\": int\n }\n}"},{"id":"f43db64a-31f6-454a-aa7a-15d33de1dd60","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{your_dialer}.hitrate.tech:3007/api/call_result/34"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"185"},{"key":"etag","value":"W/\"b9-jLj+o+PPd6fAK+aZcjYGnPV8hpM\""},{"key":"date","value":"Fri, 24 Jan 2025 09:16:08 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"call_result\": {\n \"id\": 34,\n \"type\": \"Recurring\",\n \"type_id\": 4,\n \"title\": \"Custom recurring call - dailer call again agent picks time\",\n \"retry\": \"1440\",\n \"pick_date\": 1,\n \"retry_flags\": 4\n }\n}"},{"id":"e62ad7bb-5628-45f0-9a1e-3c6cd478984b","name":"Call result not found","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{your_dialer}.hitrate.tech:3007/api/call_result/345"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"58"},{"key":"etag","value":"W/\"3a-a1gjQWQpGGW4ZNaZQV89NVmZBVg\""},{"key":"date","value":"Fri, 24 Jan 2025 09:16:23 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"The call result was not found\"\n}"}],"_postman_id":"f09cd1a7-b99c-4793-8f97-1ede8eba9fa4"},{"name":"Create call result","id":"9e5f7136-2adc-4bb6-b1f3-c143723e6249","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true},"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{API token}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"call_result_type_id\": int,\r\n \"retry\": int,\r\n \"retry_flags\": int,\r\n \"title\": string,\r\n \"pick_date\": boolean\r\n}","options":{"raw":{"language":"json"}}},"url":"{your_dialer}.hitrate.tech:3007/api/call_result","description":"Creates a new call result.
\ncall_result_type_id is required along with title.
\nIf call_result_type_id is 4 or 5, which are \"recurring\" calls, then retry_flags is also required.
\ncall_result_type_id: 1 - order, 2 - loss, 3 - no thanks, 4 - recurring, 5 - order recurring
retry: expressed in minutes, time until next call
retry_flags: bit map that controls when or how the customer gets called again
1: Private callback - agent can see this under \"my recurring calls\" & the recurring widget. Manual.
\n2: Public callback - all agents can see this under \"public recurring\". Manual.
\n4: Dialer callback - the dialer will call this customer again. Automatic.
\ntitle: name of callr result, shown to agent and in statistics
pick_date: should the agent control when next call takes place, yes/no
Functions the same as creating a call result.
\nAny parameter not included in JSON body will have the same value on a updated call_result, so you only need include the data you want to be updated.
\nSome call_results can't be edited and will give you an error, these are below id 50.
\n","urlObject":{"port":"3007","path":["api","call_result",":id"],"host":["{your_dialer}.hitrate.tech"],"query":[],"variable":[{"id":"5cb539a7-f39f-4286-9227-16f4ee82dbc6","type":"any","value":"","key":"id"}]}},"response":[{"id":"33bec722-8a08-4244-b7c2-9efc8bd8ab07","name":"Successfully updated call result","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"call_result_type_id\": 4\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{your_dialer}.hitrate.tech:3007/api/call_result/:id","host":["{your_dialer}.hitrate.tech"],"port":"3007","path":["api","call_result",":id"],"variable":[{"key":"id","value":"62"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"54"},{"key":"etag","value":"W/\"36-tYXaQ/WpR0HmSECMSyRaB6RxzXU\""},{"key":"date","value":"Fri, 24 Jan 2025 09:27:22 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"status\": \"success\",\n \"id\": 62\n }\n}"},{"id":"95262b02-dc94-4956-90da-b1d3681e3a5f","name":"Error - updating standard call result","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"call_result_type_id\": 4\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{your_dialer}.hitrate.tech:3007/api/call_result/:id","host":["{your_dialer}.hitrate.tech"],"port":"3007","path":["api","call_result",":id"],"variable":[{"key":"id","value":"1"}]}},"status":"Method Not Allowed","code":405,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"59"},{"key":"etag","value":"W/\"3b-iViZk5krkTOTMgrlbyXyWEYKTIU\""},{"key":"date","value":"Fri, 24 Jan 2025 09:26:59 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"This call result is not allowed to be updated\"\n}"},{"id":"3ea04a01-1d11-42c9-a1c0-93cda7277515","name":"Changing type with wrong flags","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"call_result_type_id\": 2,\r\n \"retry_flags\": 4\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{your_dialer}.hitrate.tech:3007/api/call_result/:id","host":["{your_dialer}.hitrate.tech"],"port":"3007","path":["api","call_result",":id"],"variable":[{"key":"id","value":"62"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"89"},{"key":"etag","value":"W/\"59-1Uf2OGWP2JgcXskGCONkk+8TR0U\""},{"key":"date","value":"Fri, 24 Jan 2025 09:29:04 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"errors\": [\n \"retry_flags must be null when call_result_type_id is not 4\"\n ]\n}"}],"_postman_id":"1c56bf82-beec-4bde-abf6-4ff4f95f4dae"},{"name":"Delete call result","id":"924db52c-1e51-4cfc-889c-12cc9212ea9b","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true},"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{API token}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{your_dialer}.hitrate.tech:3007/api/call_result/:id","description":"Removes a call result.
\nThis action can be reverted, previous calls with the deleted call result will remain the same but the call result cannot be used in future calls.
\nDeleted call results can be restored by Hitrate admin or support.
\n","urlObject":{"port":"3007","path":["api","call_result",":id"],"host":["{your_dialer}.hitrate.tech"],"query":[],"variable":[{"id":"0af673a5-7004-429e-8fa0-f910086e04de","description":{"content":"Call result to be deleted
\n","type":"text/plain"},"type":"any","value":"int","key":"id"}]}},"response":[{"id":"a32cd057-495e-42e8-a567-8da99caee004","name":"Success","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{your_dialer}.hitrate.tech:3007/api/call_result/:id","host":["{your_dialer}.hitrate.tech"],"port":"3007","path":["api","call_result",":id"],"variable":[{"key":"id","value":"62"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"93"},{"key":"etag","value":"W/\"5d-9kfR9tthZG6sn44+ujaRM9UPQIQ\""},{"key":"date","value":"Fri, 24 Jan 2025 09:30:14 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Call result is now deleted\",\n \"result\": {\n \"status\": \"success\",\n \"id\": 62\n }\n}"},{"id":"bb6039af-cce6-4cf9-a347-9495574860fe","name":"Call result not found","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{your_dialer}.hitrate.tech:3007/api/call_result/:id","host":["{your_dialer}.hitrate.tech"],"port":"3007","path":["api","call_result",":id"],"variable":[{"key":"id","value":"66666"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"85"},{"key":"etag","value":"W/\"55-faucLGFktyohELzg4zMlJJXA8+8\""},{"key":"date","value":"Fri, 24 Jan 2025 09:29:38 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"message\": \"Can't find the call result based on your call result ID\"\n}"},{"id":"1dd54c31-4605-46bd-a903-ab1e13f55859","name":"Error - trying to delete standard call result","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{your_dialer}.hitrate.tech:3007/api/call_result/:id","host":["{your_dialer}.hitrate.tech"],"port":"3007","path":["api","call_result",":id"],"variable":[{"key":"id","value":"1"}]}},"status":"Method Not Allowed","code":405,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"75"},{"key":"etag","value":"W/\"4b-G8axZrwET/KqZVdnzL2sH8IKzpc\""},{"key":"date","value":"Fri, 24 Jan 2025 09:29:50 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"message\": \"This call result is not allowed to be deleted\"\n}"}],"_postman_id":"924db52c-1e51-4cfc-889c-12cc9212ea9b"}],"id":"7caea0ee-465a-458f-9035-e459c92aa43d","description":"Search and get info on calls made on different campaigns in the dailer.
\nAll calls are included, even if they are made with the robot or never reached the customer.
\n","_postman_id":"7caea0ee-465a-458f-9035-e459c92aa43d","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{API token}"}]},"isInherited":true,"source":{"_postman_id":"023d17ad-66f9-41ca-b576-cc71fb619feb","id":"023d17ad-66f9-41ca-b576-cc71fb619feb","name":"HitrateAPI 1.4.4","type":"collection"}}},{"name":"Campaign","item":[{"name":"Get campaigns","id":"6a510744-a8ec-4427-a83a-9166fd222af4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{your_dialer}.hitrate.tech:3007/api/campaigns","description":"Lists all campaigns that are active, paused, or stopped.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{API token}"}]},"isInherited":true,"source":{"_postman_id":"023d17ad-66f9-41ca-b576-cc71fb619feb","id":"023d17ad-66f9-41ca-b576-cc71fb619feb","name":"HitrateAPI 1.4.4","type":"collection"}},"urlObject":{"port":"3007","path":["api","campaigns"],"host":["{your_dialer}.hitrate.tech"],"query":[],"variable":[]}},"response":[{"id":"4a953aad-8e65-4e4c-854d-01a687196212","name":"Success","originalRequest":{"method":"GET","header":[],"url":"https://{your_dialer}.hitrate.tech:3007/api/campaigns"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"1591"},{"key":"etag","value":"W/\"637-dm1/AEsY+5IWFPfiWfhjT55WBBw\""},{"key":"date","value":"Fri, 30 Aug 2024 12:00:50 GMT"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 1,\n \"name\": \"Data Package Upgrades\"\n },\n {\n \"id\": 3,\n \"name\": \"SF Cinema Subscription\"\n },\n {\n \"id\": 5,\n \"name\": \"new predictive dialer test\"\n },\n {\n \"id\": 8,\n \"name\": \"Animal snacks\"\n },\n {\n \"id\": 45,\n \"name\": \"test\"\n }\n]"}],"_postman_id":"6a510744-a8ec-4427-a83a-9166fd222af4"},{"name":"Get specific campaign","id":"5cc40029-a875-4032-8707-c46fb2202720","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{your_dialer}.hitrate.tech:3007/api/campaigns/:id","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{API token}"}]},"isInherited":true,"source":{"_postman_id":"023d17ad-66f9-41ca-b576-cc71fb619feb","id":"023d17ad-66f9-41ca-b576-cc71fb619feb","name":"HitrateAPI 1.4.4","type":"collection"}},"urlObject":{"port":"3007","path":["api","campaigns",":id"],"host":["{your_dialer}.hitrate.tech"],"query":[],"variable":[{"description":{"content":"Id for the campaign
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"441e8961-a24c-4939-a514-14262213438d","name":"Success","originalRequest":{"method":"GET","header":[],"url":"https://{your_dialer}.hitrate.tech:3007/api/campaigns/8"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"31"},{"key":"etag","value":"W/\"1f-YKz1HJweC7DwkfzFHsu9xFbK0ek\""},{"key":"date","value":"Fri, 30 Aug 2024 12:02:52 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 8,\n \"name\": \"Animal snacks\"\n}"},{"id":"6a34a289-82b4-4e55-b980-24d814b6edb4","name":"Campaign doesn't exist","originalRequest":{"method":"GET","header":[],"url":{"raw":"{your_dialer}.hitrate.tech:3007/api/campaigns/:id","host":["{your_dialer}.hitrate.tech"],"port":"3007","path":["api","campaigns",":id"],"variable":[{"key":"id","value":"164","description":"Id for the campaign"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"66"},{"key":"etag","value":"W/\"42-G6uGGckrybY3dYknWYsnyb92cX0\""},{"key":"date","value":"Thu, 03 Jul 2025 07:02:30 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Campaigns does not exist or you dont have permission\"\n}"}],"_postman_id":"5cc40029-a875-4032-8707-c46fb2202720"},{"name":"List campaign products","id":"6b19bc5a-c769-4ea5-b694-c799050be279","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{your_dialer}.hitrate.tech:3007/api/campaign/products/?campaign_id=&product_id=","description":"Lists all product templates that are on a campaign along with any options for email, sms template or digital document added.
\nPower of attorney means that this product stops any other product on an order from being confirmed fully until the products assigned digital document is signed.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{API token}"}]},"isInherited":true,"source":{"_postman_id":"023d17ad-66f9-41ca-b576-cc71fb619feb","id":"023d17ad-66f9-41ca-b576-cc71fb619feb","name":"HitrateAPI 1.4.4","type":"collection"}},"urlObject":{"port":"3007","path":["api","campaign","products",""],"host":["{your_dialer}.hitrate.tech"],"query":[{"description":{"content":"Grabs all products on campaign
\n","type":"text/plain"},"key":"campaign_id","value":""},{"description":{"content":"Grabs all campaigns that has the product
\n","type":"text/plain"},"key":"product_id","value":""}],"variable":[]}},"response":[{"id":"93bb91c7-e8f4-4eee-879e-8e8475c7910f","name":"List all campaigns","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://{your_dialer}.hitrate.tech:3007/api/campaign/products/?campaign_id=&product_id=","protocol":"https","host":["{your_dialer}.hitrate.tech"],"port":"3007","path":["api","campaign","products",""],"query":[{"key":"campaign_id","value":""},{"key":"product_id","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"11660"},{"key":"etag","value":"W/\"2d8c-vxXQZ3Qd2x6Lz9qWcbP1i+Cs3wQ\""},{"key":"date","value":"Fri, 30 Aug 2024 12:04:04 GMT"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 3,\n \"campaign_id\": 1,\n \"product_id\": 2,\n \"sms_template_id\": 4,\n \"email_template_id\": null,\n \"scrive_template_id\": null,\n \"is_power_of_attorney\": 0\n },\n {\n \"id\": 4,\n \"campaign_id\": 1,\n \"product_id\": 1,\n \"sms_template_id\": 4,\n \"email_template_id\": null,\n \"scrive_template_id\": null,\n \"is_power_of_attorney\": 0\n },\n {\n \"id\": 5,\n \"campaign_id\": 1,\n \"product_id\": 3,\n \"sms_template_id\": 4,\n \"email_template_id\": null,\n \"scrive_template_id\": null,\n \"is_power_of_attorney\": 0\n },\n {\n \"id\": 6,\n \"campaign_id\": 3,\n \"product_id\": 4,\n \"sms_template_id\": null,\n \"email_template_id\": null,\n \"scrive_template_id\": null,\n \"is_power_of_attorney\": 0\n },\n {\n \"id\": 7,\n \"campaign_id\": 4,\n \"product_id\": 3,\n \"sms_template_id\": null,\n \"email_template_id\": null,\n \"scrive_template_id\": null,\n \"is_power_of_attorney\": 0\n },\n {\n \"id\": 9,\n \"campaign_id\": 6,\n \"product_id\": 2,\n \"sms_template_id\": null,\n \"email_template_id\": null,\n \"scrive_template_id\": null,\n \"is_power_of_attorney\": 0\n },\n {\n \"id\": 10,\n \"campaign_id\": 6,\n \"product_id\": 1,\n \"sms_template_id\": null,\n \"email_template_id\": null,\n \"scrive_template_id\": null,\n \"is_power_of_attorney\": 0\n },\n {\n \"id\": 11,\n \"campaign_id\": 6,\n \"product_id\": 3,\n \"sms_template_id\": null,\n \"email_template_id\": null,\n \"scrive_template_id\": null,\n \"is_power_of_attorney\": 0\n }\n]"},{"id":"b28f3550-6014-4ae8-9de5-68877dea62df","name":"List specific campaign","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://{your_dialer}.hitrate.tech:3007/api/campaign/products/?campaign_id=46&product_id=","protocol":"https","host":["{your_dialer}.hitrate.tech"],"port":"3007","path":["api","campaign","products",""],"query":[{"key":"campaign_id","value":"46"},{"key":"product_id","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"429"},{"key":"etag","value":"W/\"1ad-8E4QJ/GO4aoH0PvEdL1tXel2SPk\""},{"key":"date","value":"Fri, 30 Aug 2024 12:04:59 GMT"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 105,\n \"campaign_id\": 46,\n \"product_id\": 8,\n \"sms_template_id\": null,\n \"email_template_id\": null,\n \"scrive_template_id\": null,\n \"is_power_of_attorney\": 0\n },\n {\n \"id\": 106,\n \"campaign_id\": 46,\n \"product_id\": 17,\n \"sms_template_id\": null,\n \"email_template_id\": null,\n \"scrive_template_id\": null,\n \"is_power_of_attorney\": 0\n },\n {\n \"id\": 107,\n \"campaign_id\": 46,\n \"product_id\": 18,\n \"sms_template_id\": null,\n \"email_template_id\": null,\n \"scrive_template_id\": null,\n \"is_power_of_attorney\": 0\n }\n]"},{"id":"164c8575-62f6-4f47-8797-d97ad9e5c91a","name":"List specific product","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://{your_dialer}.hitrate.tech:3007/api/campaign/products/?campaign_id=&product_id=8","protocol":"https","host":["{your_dialer}.hitrate.tech"],"port":"3007","path":["api","campaign","products",""],"query":[{"key":"campaign_id","value":""},{"key":"product_id","value":"8"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"2398"},{"key":"etag","value":"W/\"95e-ygohBJSGeCmQXZeBW5y4fFbxovc\""},{"key":"date","value":"Fri, 30 Aug 2024 12:05:27 GMT"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 16,\n \"campaign_id\": 8,\n \"product_id\": 8,\n \"sms_template_id\": null,\n \"email_template_id\": null,\n \"scrive_template_id\": null,\n \"is_power_of_attorney\": 0\n },\n {\n \"id\": 46,\n \"campaign_id\": 19,\n \"product_id\": 8,\n \"sms_template_id\": null,\n \"email_template_id\": null,\n \"scrive_template_id\": null,\n \"is_power_of_attorney\": 0\n },\n {\n \"id\": 47,\n \"campaign_id\": 21,\n \"product_id\": 8,\n \"sms_template_id\": null,\n \"email_template_id\": null,\n \"scrive_template_id\": null,\n \"is_power_of_attorney\": 0\n },\n {\n \"id\": 48,\n \"campaign_id\": 22,\n \"product_id\": 8,\n \"sms_template_id\": null,\n \"email_template_id\": null,\n \"scrive_template_id\": null,\n \"is_power_of_attorney\": 0\n },\n {\n \"id\": 49,\n \"campaign_id\": 23,\n \"product_id\": 8,\n \"sms_template_id\": null,\n \"email_template_id\": null,\n \"scrive_template_id\": null,\n \"is_power_of_attorney\": 0\n }\n]"},{"id":"e4e97c7b-b98b-4fad-9fef-2d47a99978a3","name":"No campaign product found","originalRequest":{"method":"GET","header":[],"url":{"raw":"{your_dialer}.hitrate.tech:3007/api/campaign/products/?campaign_id=64&product_id=164","host":["{your_dialer}.hitrate.tech"],"port":"3007","path":["api","campaign","products",""],"query":[{"key":"campaign_id","value":"64","description":"Grabs all products on campaign"},{"key":"product_id","value":"164","description":"Grabs all campaigns that has the product"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"2"},{"key":"etag","value":"W/\"2-l9Fw4VUO7kr8CvBlt4zaMCqXZ0w\""},{"key":"date","value":"Thu, 03 Jul 2025 07:03:46 GMT"}],"cookie":[],"responseTime":null,"body":"[]"}],"_postman_id":"6b19bc5a-c769-4ea5-b694-c799050be279"},{"name":"Create campaign product","id":"6c41d0d0-5842-485a-9a3c-fbdba0f3ef46","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"campaign_id\": int,\r\n \"product_id\": int,\r\n \"sms_template_id\": int,\r\n \"email_template_id\": int,\r\n \"scrive_template_id\": int,\r\n \"is_power_of_attorney\": int\r\n}","options":{"raw":{"language":"json"}}},"url":"{your_dialer}.hitrate.tech:3007/api/campaign/product","description":"Adds a product template to a campaign.
\nAdd any sms, email template, or digital document that should be sent out when an order contains this product.
\nSMS template and digital document will make the order count as unconfirmed to either the SMS has a valid confirmation response or the digital document is signed.
\nIs power of attorney marks a digital document as valid document for requesting services on behalf of the customer, such as moving a power contract. If there is a power of attorney product on an order, no products will count as confirm or trigger any integration until the power of attorney enabled product is confirmed.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{API token}"}]},"isInherited":true,"source":{"_postman_id":"023d17ad-66f9-41ca-b576-cc71fb619feb","id":"023d17ad-66f9-41ca-b576-cc71fb619feb","name":"HitrateAPI 1.4.4","type":"collection"}},"urlObject":{"port":"3007","path":["api","campaign","product"],"host":["{your_dialer}.hitrate.tech"],"query":[],"variable":[]}},"response":[{"id":"0a503ed8-310b-42dd-aafd-3d0e1c3077ce","name":"Product already exists","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"campaign_id\": 14,\r\n \"product_id\": 14\r\n}","options":{"raw":{"language":"json"}}},"url":"{your_dialer}.hitrate.tech:3007/api/campaign/product"},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"44"},{"key":"etag","value":"W/\"2c-amgunth6ABGg+BthTCcXaYKezP0\""},{"key":"date","value":"Thu, 03 Jul 2025 07:05:10 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Campaign Product already exist\"\n}"},{"id":"a241a1f3-a465-49b6-9365-cf48d9d4b6bd","name":"Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"campaign_id\": 36,\r\n \"product_id\": 25\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{your_dialer}.hitrate.tech:3007/api/campaign/product"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"29"},{"key":"etag","value":"W/\"1d-L7jooM2p1astJhGqaSozrO7q41I\""},{"key":"date","value":"Fri, 30 Aug 2024 12:06:55 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"id\": 110\n}"}],"_postman_id":"6c41d0d0-5842-485a-9a3c-fbdba0f3ef46"},{"name":"Update campaign products","id":"e9124c85-d688-45cc-96e0-f4ffd50049b1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"sms_template_id\": int,\r\n \"email_template_id\": int,\r\n \"scrive_template_id\": int,\r\n \"is_power_of_attorney\": int\r\n}","options":{"raw":{"language":"json"}}},"url":"{your_dialer}.hitrate.tech:3007/api/campaign/:campaign_id/product/:product_id","description":"Updates products or campaigns with new values.
\nIf only campaign_id is used for path variable then ALL products on that campaign will have their value updated.
\nIf only product_id is used for path variable, then ALL campaigns that has that product will have their version of the product updated.
\nPayload body for campaign_id & product_id will change this value on any matched product.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{API token}"}]},"isInherited":true,"source":{"_postman_id":"023d17ad-66f9-41ca-b576-cc71fb619feb","id":"023d17ad-66f9-41ca-b576-cc71fb619feb","name":"HitrateAPI 1.4.4","type":"collection"}},"urlObject":{"port":"3007","path":["api","campaign",":campaign_id","product",":product_id"],"host":["{your_dialer}.hitrate.tech"],"query":[],"variable":[{"id":"2f488eee-dbef-48d2-bda7-fd05664f7518","description":{"content":"Campaign the product you want to update exists on
\n","type":"text/plain"},"type":"any","value":"campaign_id","key":"campaign_id"},{"id":"243db793-a969-49c9-aa7b-92619c35ff5a","description":{"content":"The product you want to update
\n","type":"text/plain"},"type":"any","value":"product_id","key":"product_id"}]}},"response":[{"id":"ddcd37ef-353c-4719-858e-85096054d25d","name":"Update specific campaign product","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"sms_template_id\": 10\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{your_dialer}.hitrate.tech:3007/api/campaign/product/?campaign_id=36&product_id=25","protocol":"https","host":["{your_dialer}.hitrate.tech"],"port":"3007","path":["api","campaign","product",""],"query":[{"key":"campaign_id","value":"36"},{"key":"product_id","value":"25"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"59"},{"key":"etag","value":"W/\"3b-HozJp6zC1wjqcIBBBIILNJJlSSM\""},{"key":"date","value":"Fri, 30 Aug 2024 12:07:47 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"campaign_id\": \"36\",\n \"product_id\": \"25\",\n \"sms_template_id\": 10\n}"},{"id":"0cf14b2e-3b41-4087-a175-0f80f8a05bed","name":"Update all products on campaign","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"sms_template_id\": 10\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{your_dialer}.hitrate.tech:3007/api/campaign/product/?campaign_id=36","protocol":"https","host":["{your_dialer}.hitrate.tech"],"port":"3007","path":["api","campaign","product",""],"query":[{"key":"campaign_id","value":"36"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"59"},{"key":"etag","value":"W/\"3b-V9E2v7KTT/OZ1WXtD5AGkKZlaAY\""},{"key":"date","value":"Fri, 30 Aug 2024 12:08:13 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"campaign_id\": \"36\",\n \"product_id\": null,\n \"sms_template_id\": 10\n}"},{"id":"fb95cf42-1550-49da-8599-63343f49bfe3","name":"Update all campaigns with product","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"sms_template_id\": 10\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{your_dialer}.hitrate.tech:3007/api/campaign/product/?product_id=25","protocol":"https","host":["{your_dialer}.hitrate.tech"],"port":"3007","path":["api","campaign","product",""],"query":[{"key":"product_id","value":"25"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"59"},{"key":"etag","value":"W/\"3b-hN7DZv/iwvXX26Py5AVuGCAoPis\""},{"key":"date","value":"Fri, 30 Aug 2024 12:09:05 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"campaign_id\": null,\n \"product_id\": \"25\",\n \"sms_template_id\": 10\n}"}],"_postman_id":"e9124c85-d688-45cc-96e0-f4ffd50049b1"},{"name":"Delete campaign product","id":"a12dfd4d-5441-4930-932f-8b4930a7b3a5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"{your_dialer}.hitrate.tech:3007/api/campaign/product/:id","description":"Deletes specific product template on a campaign, use the specific campaign_product_id which can be found when searching for campaign product.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{API token}"}]},"isInherited":true,"source":{"_postman_id":"023d17ad-66f9-41ca-b576-cc71fb619feb","id":"023d17ad-66f9-41ca-b576-cc71fb619feb","name":"HitrateAPI 1.4.4","type":"collection"}},"urlObject":{"port":"3007","path":["api","campaign","product",":id"],"host":["{your_dialer}.hitrate.tech"],"query":[],"variable":[{"id":"bf263d87-3122-4468-a207-5fde8d8f3e5d","type":"any","value":"","key":"id"}]}},"response":[{"id":"e8cafc61-8ee6-469e-9c4e-3f8382532472","name":"Success","originalRequest":{"method":"DELETE","header":[],"url":"https://{your_dialer}.hitrate.tech:3007/api/campaign/product/86"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"51"},{"key":"etag","value":"W/\"33-ntveIKXKa0h6h9+SvIQk07ECNrw\""},{"key":"date","value":"Fri, 30 Aug 2024 12:10:14 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"86\",\n \"message\": \"Campaign Product is deleted\"\n}"},{"id":"75beff07-79cd-4b43-9038-1515257e5bce","name":"Campaign product not found","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{your_dialer}.hitrate.tech:3007/api/campaign/product/:id","host":["{your_dialer}.hitrate.tech"],"port":"3007","path":["api","campaign","product",":id"],"variable":[{"key":"id","value":"12"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"40"},{"key":"etag","value":"W/\"28-1hYt7iMxKBfxUXYa5RR10MX1FoE\""},{"key":"date","value":"Thu, 03 Jul 2025 07:06:40 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Campaign product not found\"\n}"}],"_postman_id":"a12dfd4d-5441-4930-932f-8b4930a7b3a5"},{"name":"View contactlists on campaign","id":"22029895-7c9b-44bb-b360-8fb40abf1058","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{your_dialer}.hitrate.tech:3007/api/campaign/contactlists?campaign_id=&contactlist_id=","description":"Show all contactlists that are active on a campaign. The dailer mixes the contactlists automatically depending on the settings for predictive/automatic/click-to-call.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{API token}"}]},"isInherited":true,"source":{"_postman_id":"023d17ad-66f9-41ca-b576-cc71fb619feb","id":"023d17ad-66f9-41ca-b576-cc71fb619feb","name":"HitrateAPI 1.4.4","type":"collection"}},"urlObject":{"port":"3007","path":["api","campaign","contactlists"],"host":["{your_dialer}.hitrate.tech"],"query":[{"key":"campaign_id","value":""},{"key":"contactlist_id","value":""}],"variable":[]}},"response":[{"id":"62f56fb3-b2ab-482a-be82-4cf03c97f764","name":"View contactlists on campaign","originalRequest":{"method":"GET","header":[],"url":{"raw":"{your_dialer}.hitrate.tech:3007/api/campaign/contactlists?campaign_id=&contactlist_id=","host":["{your_dialer}.hitrate.tech"],"port":"3007","path":["api","campaign","contactlists"],"query":[{"key":"campaign_id","value":""},{"key":"contactlist_id","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"950"},{"key":"etag","value":"W/\"3b6-GVyzB4vxUcRZNfVeoT7g6pslNT8\""},{"key":"date","value":"Mon, 11 Nov 2024 09:02:18 GMT"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 42,\n \"campaign_id\": 22,\n \"contactlist_id\": 34,\n \"start_date\": null,\n \"end_date\": null,\n \"block_public_recurring\": 0,\n \"block_private_recurring\": 0\n },\n {\n \"id\": 50,\n \"campaign_id\": 2,\n \"contactlist_id\": 34,\n \"start_date\": null,\n \"end_date\": null,\n \"block_public_recurring\": 0,\n \"block_private_recurring\": 0\n },\n {\n \"id\": 54,\n \"campaign_id\": 6,\n \"contactlist_id\": 34,\n \"start_date\": null,\n \"end_date\": null,\n \"block_public_recurring\": 0,\n \"block_private_recurring\": 0\n },\n {\n \"id\": 58,\n \"campaign_id\": 10,\n \"contactlist_id\": 34,\n \"start_date\": null,\n \"end_date\": null,\n \"block_public_recurring\": 0,\n \"block_private_recurring\": 0\n }\n]"},{"id":"f052ff49-822b-4abd-950c-35be0bb2fa76","name":"No contactlist found","originalRequest":{"method":"GET","header":[],"url":{"raw":"{your_dialer}.hitrate.tech:3007/api/campaign/contactlists?campaign_id=&contactlist_id=2","host":["{your_dialer}.hitrate.tech"],"port":"3007","path":["api","campaign","contactlists"],"query":[{"key":"campaign_id","value":""},{"key":"contactlist_id","value":"2"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"36"},{"key":"etag","value":"W/\"24-oafGd01Tx8OGOAzobdY0z8l1axA\""},{"key":"date","value":"Mon, 11 Nov 2024 09:03:57 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Contactlists not found\"\n}"}],"_postman_id":"22029895-7c9b-44bb-b360-8fb40abf1058"},{"name":"Activate contactlist on campaign","id":"af92bafe-c32f-4324-81c8-66533d119d88","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"campaign_id\": int,\r\n \"contactlist_id\": int\r\n}","options":{"raw":{"language":"json"}}},"url":"{your_dialer}.hitrate.tech:3007/api/campaign/contactlist","description":"Adds a contactlist to a campaign, this can be done as agents are actively calling on the campaign. How fast the contactlist will start getting calls depends on how many agents are on the campaign and how much they are calling.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{API token}"}]},"isInherited":true,"source":{"_postman_id":"023d17ad-66f9-41ca-b576-cc71fb619feb","id":"023d17ad-66f9-41ca-b576-cc71fb619feb","name":"HitrateAPI 1.4.4","type":"collection"}},"urlObject":{"port":"3007","path":["api","campaign","contactlist"],"host":["{your_dialer}.hitrate.tech"],"query":[],"variable":[]}},"response":[{"id":"9b4cc0ce-89eb-417d-a28f-be13bfd100fe","name":"Contactlist activated","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"campaign_id\": 2,\r\n \"contactlist_id\": 2\r\n}","options":{"raw":{"language":"json"}}},"url":"{your_dialer}.hitrate.tech:3007/api/campaign/contactlist"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"28"},{"key":"etag","value":"W/\"1c-MEvg3k8ZmkcveFxAGAL4JMBRPY4\""},{"key":"date","value":"Mon, 11 Nov 2024 09:06:05 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"id\": 79\n}"},{"id":"4ae23bee-d682-4cbe-9bd2-56d9bc4caa17","name":"Contactlist doesn't exist","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"campaign_id\": 2,\r\n \"contactlist_id\": 124\r\n}","options":{"raw":{"language":"json"}}},"url":"{your_dialer}.hitrate.tech:3007/api/campaign/contactlist"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"40"},{"key":"etag","value":"W/\"28-qbZd3HquQAbY9DeT0QOdq84lSNE\""},{"key":"date","value":"Thu, 03 Jul 2025 07:07:35 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Contactlist does not exist\"\n}"},{"id":"9b416474-e8dd-4f86-a607-a83e5aef88d4","name":"Campaign doesn't exist","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"campaign_id\": 24,\r\n \"contactlist_id\": 2\r\n}","options":{"raw":{"language":"json"}}},"url":"{your_dialer}.hitrate.tech:3007/api/campaign/contactlist"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"37"},{"key":"etag","value":"W/\"25-ZyZR/yU2m8Hnym18wmo8FzSRATY\""},{"key":"date","value":"Thu, 03 Jul 2025 07:07:57 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Campaign does not exist\"\n}"}],"_postman_id":"af92bafe-c32f-4324-81c8-66533d119d88"},{"name":"Remove contactlist from campaign","id":"ffa7818a-9767-4815-bede-ef585cd6ef74","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"{your_dialer}.hitrate.tech:3007/api/campaign/contactlist/:id","description":"Inactivates a specific contactlist from a campaign.
\nIf the same contactlist is added in the future, the dialer will continue calling the customers in the same state as they were in when the cotnactlist was inactivated.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{API token}"}]},"isInherited":true,"source":{"_postman_id":"023d17ad-66f9-41ca-b576-cc71fb619feb","id":"023d17ad-66f9-41ca-b576-cc71fb619feb","name":"HitrateAPI 1.4.4","type":"collection"}},"urlObject":{"port":"3007","path":["api","campaign","contactlist",":id"],"host":["{your_dialer}.hitrate.tech"],"query":[],"variable":[{"id":"64f7f0f5-91ee-498b-83ea-54324160ac18","description":{"content":"Campaign contaclist id to delete from campaign
\n","type":"text/plain"},"type":"any","value":"campaign_contactlist_id","key":"id"}]}},"response":[{"id":"c8fad058-4185-4935-899d-77229cf28997","name":"Removed contactlist from campaign","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{your_dialer}.hitrate.tech:3007/api/campaign/contactlist/:id","host":["{your_dialer}.hitrate.tech"],"port":"3007","path":["api","campaign","contactlist",":id"],"variable":[{"key":"id","value":"79"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"28"},{"key":"etag","value":"W/\"1c-MEvg3k8ZmkcveFxAGAL4JMBRPY4\""},{"key":"date","value":"Mon, 11 Nov 2024 09:08:32 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"id\": 79\n}"},{"id":"3d076bfb-6dcf-479c-887e-f5e06653665b","name":"Can't find the campaign contactlist","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{your_dialer}.hitrate.tech:3007/api/campaign/contactlist/:id","host":["{your_dialer}.hitrate.tech"],"port":"3007","path":["api","campaign","contactlist",":id"],"variable":[{"key":"id","value":"79"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"49"},{"key":"etag","value":"W/\"31-fXfQckBoMas/ZPpBumb//kkmvFA\""},{"key":"date","value":"Mon, 11 Nov 2024 09:08:39 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"can't find the campaign_contactlist\"\n}"}],"_postman_id":"ffa7818a-9767-4815-bede-ef585cd6ef74"}],"id":"4e4b6eef-735c-4c71-8c4c-5fcf106f7d56","description":"Control active campaigns by assigning products and other objects to them through the API.
\nEach campaign calls and keeps it's data seperate from other campaigns.
\n","_postman_id":"4e4b6eef-735c-4c71-8c4c-5fcf106f7d56","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{API token}"}]},"isInherited":true,"source":{"_postman_id":"023d17ad-66f9-41ca-b576-cc71fb619feb","id":"023d17ad-66f9-41ca-b576-cc71fb619feb","name":"HitrateAPI 1.4.4","type":"collection"}}},{"name":"Client","item":[{"name":"Get information on client","id":"66078389-7a4f-401d-ab62-2fa02f4b2938","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true},"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{API token}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{your_dialer}.hitrate.tech:3007/api/client/:id","description":"Edit values on a contactlist and returns the edited list.
\n","urlObject":{"port":"3007","path":["api","client",":id"],"host":["{your_dialer}.hitrate.tech"],"query":[],"variable":[{"description":{"content":"Get information on this client
\n","type":"text/plain"},"type":"any","value":"client_id","key":"id"}]}},"response":[{"id":"38bffc0f-3634-4559-a6bd-9d4202cd09a8","name":"Missing ID","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{your_dialer}.hitrate.tech:3007/api/client/:id","host":["{your_dialer}.hitrate.tech"],"port":"3007","path":["api","client",":id"],"variable":[{"key":"id","value":""}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"42"},{"key":"etag","value":"W/\"2a-iVFv4QaMdoWZTS2WyYTuCF57yzk\""},{"key":"date","value":"Thu, 19 Jun 2025 13:51:03 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": \"id is required\"\n}"},{"id":"3552426d-da8b-4d2d-8da5-0deee00b8fc2","name":"Client found","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{your_dialer}.hitrate.tech:3007/api/client/:id","host":["{your_dialer}.hitrate.tech"],"port":"3007","path":["api","client",":id"],"variable":[{"key":"id","value":"client_id","description":"Get information on this client"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"66"},{"key":"etag","value":"W/\"42-jo9pOHGchupm7GT3x1CtF5dCyoM\""},{"key":"date","value":"Thu, 19 Jun 2025 13:51:22 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"client\": {\n \"id\": 2,\n \"name\": \"Hitrate\",\n \"office_id\": 10\n }\n}"},{"id":"03969f1b-f656-4125-93d2-70d7fbf373e9","name":"Client not found","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{your_dialer}.hitrate.tech:3007/api/client/:id","host":["{your_dialer}.hitrate.tech"],"port":"3007","path":["api","client",":id"],"variable":[{"key":"id","value":"2444","description":"Get information on this client"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"44"},{"key":"etag","value":"W/\"2c-E0HpP+hyPzDrzoxrkvOJIM55YNo\""},{"key":"date","value":"Thu, 03 Jul 2025 07:08:48 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": \"client not found\"\n}"}],"_postman_id":"66078389-7a4f-401d-ab62-2fa02f4b2938"},{"name":"Create new client","id":"d6b0b6f3-362d-44b9-85eb-47f16e3e3b42","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true},"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{API token}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"name\": str,\r\n \"office_id\": int\r\n}","options":{"raw":{"language":"json"}}},"url":"{your_dialer}.hitrate.tech:3007/api/client","description":"Create new client. This is purely for quality of life in the system to make products, contactlists, and campaigns easier to find and manage.
\n","urlObject":{"port":"3007","path":["api","client"],"host":["{your_dialer}.hitrate.tech"],"query":[],"variable":[]}},"response":[{"id":"3e50e8e5-f096-42a2-a213-357e72e5a26b","name":"Creation success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"Example Client ltd\",\r\n \"office_id\": 2\r\n}","options":{"raw":{"language":"json"}}},"url":"{your_dialer}.hitrate.tech:3007/api/client"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"25"},{"key":"etag","value":"W/\"19-bWmTF7t9I0bhmajw7Bq22pMmk4c\""},{"key":"date","value":"Thu, 19 Jun 2025 13:52:57 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"id\": 130\n}"},{"id":"e7f9bcc7-ec85-41c7-97e6-9e7e8cd9db4a","name":"Error, missing name","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{your_dialer}.hitrate.tech:3007/api/client"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"44"},{"key":"etag","value":"W/\"2c-pB4Ul1B5hxXZyPmrO8Mm4kyAeTU\""},{"key":"date","value":"Thu, 19 Jun 2025 13:54:07 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": \"name is required\"\n}"}],"_postman_id":"d6b0b6f3-362d-44b9-85eb-47f16e3e3b42"},{"name":"Update Client","id":"d66838e6-1c09-41b9-b0cb-11f5bfdc1a24","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true},"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{API token}"}]},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"name\": str,\r\n \"office_id\": int\r\n}","options":{"raw":{"language":"json"}}},"url":"{your_dialer}.hitrate.tech:3007/api/client/:id","description":"Updates the client with new information.
\n","urlObject":{"port":"3007","path":["api","client",":id"],"host":["{your_dialer}.hitrate.tech"],"query":[],"variable":[{"description":{"content":"This client will be updated with the info in body
\n","type":"text/plain"},"type":"any","value":"client_id","key":"id"}]}},"response":[{"id":"2233260d-8d7b-409a-8be7-a1c5817fe2e3","name":"Succesful update","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"Test Company\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{your_dialer}.hitrate.tech:3007/api/client/:id","host":["{your_dialer}.hitrate.tech"],"port":"3007","path":["api","client",":id"],"variable":[{"key":"id","value":"2","description":"This client will be updated with the info in body"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"16"},{"key":"etag","value":"W/\"10-oV4hJxRVSENxc/wX8+mA4/Pe4tA\""},{"key":"date","value":"Thu, 19 Jun 2025 13:56:47 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true\n}"},{"id":"1a51f73e-84ac-4405-b0db-21ce857b4cd2","name":"No information in body","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"{your_dialer}.hitrate.tech:3007/api/client/:id","host":["{your_dialer}.hitrate.tech"],"port":"3007","path":["api","client",":id"],"variable":[{"key":"id","value":"2","description":"This client will be updated with the info in body"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"44"},{"key":"etag","value":"W/\"2c-pB4Ul1B5hxXZyPmrO8Mm4kyAeTU\""},{"key":"date","value":"Thu, 19 Jun 2025 13:57:13 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": \"name is required\"\n}"},{"id":"89ba229e-abc9-4c02-9205-0347e533dc26","name":"Missing ID","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"Test Company\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{your_dialer}.hitrate.tech:3007/api/client/:id","host":["{your_dialer}.hitrate.tech"],"port":"3007","path":["api","client",":id"],"variable":[{"key":"id","value":"","description":"This client will be updated with the info in body"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"42"},{"key":"etag","value":"W/\"2a-iVFv4QaMdoWZTS2WyYTuCF57yzk\""},{"key":"date","value":"Thu, 19 Jun 2025 13:57:36 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": \"id is required\"\n}"},{"id":"865f942b-f895-42ae-863c-a3a1312f8417","name":"No client found","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"Test Company\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{your_dialer}.hitrate.tech:3007/api/client/:id","host":["{your_dialer}.hitrate.tech"],"port":"3007","path":["api","client",":id"],"variable":[{"key":"id","value":"123","description":"This client will be updated with the info in body"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"44"},{"key":"etag","value":"W/\"2c-E0HpP+hyPzDrzoxrkvOJIM55YNo\""},{"key":"date","value":"Thu, 19 Jun 2025 13:57:51 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": \"client not found\"\n}"}],"_postman_id":"d66838e6-1c09-41b9-b0cb-11f5bfdc1a24"},{"name":"Delete Client","id":"039aa153-a8b9-408c-940f-8ebed5e9f6d3","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true},"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{API token}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{your_dialer}.hitrate.tech:3007/api/client/:id","description":"Removes the client from the system. This action can be reverted by a Hitrate admin or support.
\n","urlObject":{"port":"3007","path":["api","client",":id"],"host":["{your_dialer}.hitrate.tech"],"query":[],"variable":[{"description":{"content":"This client will be deleted
\n","type":"text/plain"},"type":"any","value":"client_id","key":"id"}]}},"response":[{"id":"0c6a42c6-ff34-4421-bbdb-adc9ed78cf18","name":"Missing ID","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{your_dialer}.hitrate.tech:3007/api/client/:id","host":["{your_dialer}.hitrate.tech"],"port":"3007","path":["api","client",":id"],"variable":[{"key":"id","value":"client_id","description":"This client will be deleted"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"42"},{"key":"etag","value":"W/\"2a-iVFv4QaMdoWZTS2WyYTuCF57yzk\""},{"key":"date","value":"Thu, 19 Jun 2025 13:59:22 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": \"id is required\"\n}"},{"id":"49b7578e-0270-4706-ae84-88b6e50b7eb7","name":"No client found","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{your_dialer}.hitrate.tech:3007/api/client/:id","host":["{your_dialer}.hitrate.tech"],"port":"3007","path":["api","client",":id"],"variable":[{"key":"id","value":"123","description":"This client will be deleted"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"44"},{"key":"etag","value":"W/\"2c-E0HpP+hyPzDrzoxrkvOJIM55YNo\""},{"key":"date","value":"Thu, 19 Jun 2025 14:00:01 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": \"client not found\"\n}"},{"id":"7b15c543-cc92-4305-8bd1-e93c776d6b9e","name":"Client deleted","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{your_dialer}.hitrate.tech:3007/api/client/:id","host":["{your_dialer}.hitrate.tech"],"port":"3007","path":["api","client",":id"],"variable":[{"key":"id","value":"130","description":"This client will be deleted"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"16"},{"key":"etag","value":"W/\"10-oV4hJxRVSENxc/wX8+mA4/Pe4tA\""},{"key":"date","value":"Thu, 19 Jun 2025 14:00:14 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true\n}"}],"_postman_id":"039aa153-a8b9-408c-940f-8ebed5e9f6d3"}],"id":"ce0395da-2ccb-4332-91ca-1a8e559b8724","description":"Clients are a concept to help organize campaigns, products, and contactlists in the system. If you have multiple campaigns that work with different companies, clients, or groups you can tie them to a campaign to make them easier to manage.
\nMost of the features are for statistics or ease of use within the system itself. Assinging or creating clients are optional.
\n","_postman_id":"ce0395da-2ccb-4332-91ca-1a8e559b8724","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{API token}"}]},"isInherited":true,"source":{"_postman_id":"023d17ad-66f9-41ca-b576-cc71fb619feb","id":"023d17ad-66f9-41ca-b576-cc71fb619feb","name":"HitrateAPI 1.4.4","type":"collection"}}},{"name":"Contactlists","item":[{"name":"Create new contactlist","id":"c9d71c36-6cdd-4149-ac69-f7d3fcbc174f","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true},"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{API token}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"title\": str,\r\n \"keep_order_on_prune\": boolean,\r\n \"is_company\": boolean,\r\n \"user_group_id\": int,\r\n \"office_id\": int,\r\n \"prune_date\": datetime,\r\n \"source\": str\r\n}"},"url":"{your_dialer}.hitrate.tech:3007/api/contactlist","description":"Creates a new empty contactlist and returns the ID. Populate with customers after creation.
\nKeep_order_on_prune: keeps all customer data in the event that a contactlist gets pruned, deleted according to GDPR.
\nIs_company: Customers on this list are companies. Changes how data is presented on customer card and how the customer is handled by the dialer robot.
\nOffice_id: assign this contactlist to an office, if the office is in limited mode the users on this office can only see contactlists that belong to their office.
\nPrune_date: the contactlist is automatically deleted upon this date with all customer information removed.❗**This cannot be reversed.**❗
\nSource: Optional value that allows tracking of where the contactlist orignates from.
\n","urlObject":{"port":"3007","path":["api","contactlist"],"host":["{your_dialer}.hitrate.tech"],"query":[],"variable":[]}},"response":[{"id":"ee94ec12-79a9-411c-8568-e51867d96048","name":"Creation success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"title\": \"New_customerlist\",\r\n \"keep_order_on_prune\": 1,\r\n \"is_company\": 0,\r\n \"user_group_id\": 4,\r\n \"prune_date\": \"2026-07-01\"\r\n}"},"url":"{your_dialer}.hitrate.tech:3007/api/contactlist"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"28"},{"key":"etag","value":"W/\"1c-iZ/s6EZll5Vp3UVeE7qlZoq7ZCU\""},{"key":"date","value":"Thu, 18 Jan 2024 07:35:18 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"id\": 69\n}"},{"id":"0ed32fd1-af29-4118-bcbe-1ba563279bf1","name":"Creation without parameters","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"title\": \"New_customerlist\"\r\n}"},"url":"https://{{Dialer URL}}:3007/api/contactlist"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"28"},{"key":"etag","value":"W/\"1c-CwXEPXBIlz+r9Ty86oSvfSV7vyw\""},{"key":"date","value":"Thu, 18 Jan 2024 07:36:25 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"id\": 71\n}"},{"id":"991aeb69-0971-45cc-9398-6953655b41bc","name":"Missing title","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"keep_order_on_prune\": true,\r\n \"is_company\": false,\r\n \"office_id\": 2,\r\n \"prune_date\": \"2025-09-02\"\r\n}"},"url":"{your_dialer}.hitrate.tech:3007/api/contactlist"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"35"},{"key":"etag","value":"W/\"23-RcMU/MuuOW0A7/ScRi+yMTYsBdg\""},{"key":"date","value":"Thu, 03 Jul 2025 07:11:32 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"title field not found\"\n}"},{"id":"28c56768-79d7-4171-a10f-94c35a7539b2","name":"Missing required values","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"keep_order_on_prune\": 1,\r\n \"is_company\": 0,\r\n \"user_group_id\": 4,\r\n \"prune_date\": \"2026-07-01\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{your_dialer}.hitrate.tech:3007/api/contactlist"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"71"},{"key":"etag","value":"W/\"47-RJck20a5XB6X1Euyc0IrhJDHLJ0\""},{"key":"date","value":"Wed, 06 Nov 2024 09:45:08 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": \"false\",\n \"error\": \"Server Error\",\n \"details\": \"Validation error\"\n}"}],"_postman_id":"c9d71c36-6cdd-4149-ac69-f7d3fcbc174f"},{"name":"Edit contactlist","id":"1346bff3-5061-4e45-9b71-c0ca4e91eee6","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true},"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{API token}"}]},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"title\": str,\r\n \"keep_order_on_prune\": boolean,\r\n \"is_company\": boolean,\r\n \"user_group_id\": int,\r\n \"office_id\": int,\r\n \"prune_date\": datetime\r\n}"},"url":"https://{your_dialer}.hitrate.tech:3007/api/contactlist/:id","description":"Edit values on a contactlist and returns the edited list.
\nAny key that isn't sent in the body will retain the value it had, only data that you wish to update is neccesary to include.
\n","urlObject":{"protocol":"https","port":"3007","path":["api","contactlist",":id"],"host":["{your_dialer}.hitrate.tech"],"query":[],"variable":[{"id":"eeb65542-2c1f-4462-a69f-92a0723c2035","description":{"content":"Decides which contactlist to edit
\n","type":"text/plain"},"type":"any","value":"contactlist_id","key":"id"}]}},"response":[{"id":"5569da21-aa84-4db3-956a-950467898c01","name":"Edited contactlist","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"title\": \"New title\",\r\n \"keep_order_on_prune\": 1,\r\n \"is_company\": 1,\r\n \"user_group_id\": 3,\r\n \"prune_date\": \"2037-03-01\"\r\n}"},"url":"https://{{Dialer URL}}:3007/api/contactlist/69"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"105"},{"key":"etag","value":"W/\"69-jE/rF2tNkHpyUUjv11gloJIBjow\""},{"key":"date","value":"Thu, 18 Jan 2024 11:56:02 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"69\",\n \"title\": \"New title\",\n \"keep_order_on_prune\": 1,\n \"is_company\": 1,\n \"prune_date\": \"2037-03-01 00:00:00\"\n}"},{"id":"10698b05-c4ca-4131-916c-8fe713f154f3","name":"Change list to company","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"is_company\": 1\r\n}"},"url":"https://{{Dialer URL}}:3007/api/contactlist/69"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"26"},{"key":"etag","value":"W/\"1a-i2J8qW7iP4f4V4qMvFbE7APMml0\""},{"key":"date","value":"Thu, 18 Jan 2024 11:56:47 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"69\",\n \"is_company\": 1\n}"}],"_postman_id":"1346bff3-5061-4e45-9b71-c0ca4e91eee6"},{"name":"View contactlist info","id":"2b9ef3ea-062b-4faa-838c-c84968af4c11","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{API token}"}]},"isInherited":false},"method":"GET","header":[],"url":"{your_dialer}.hitrate.tech:3007/api/contactlist/:id","description":"View description of a contactlist. Such as name, creation time, update time, contactlist type (B2C or B2B) as well as how many contacts exists within it.
\n","urlObject":{"port":"3007","path":["api","contactlist",":id"],"host":["{your_dialer}.hitrate.tech"],"query":[],"variable":[{"id":"98f86b02-6cb1-478f-9cd6-3a81b542de20","description":{"content":"The id for the contactlist you want to check
\n","type":"text/plain"},"type":"any","value":"contactlist_id","key":"id"}]}},"response":[{"id":"84479542-c783-49a4-add5-10b1267f602b","name":"View list 34","originalRequest":{"method":"GET","header":[],"url":{"raw":"{your_dialer}.hitrate.tech:3007/api/contactlist/:id","host":["{your_dialer}.hitrate.tech"],"port":"3007","path":["api","contactlist",":id"],"variable":[{"key":"id","value":"34"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"233"},{"key":"etag","value":"W/\"e9-w847NRIUQbNcYwyX0fBP+1vf/zA\""},{"key":"date","value":"Mon, 11 Nov 2024 08:14:43 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 34,\n \"office_id\": 10,\n \"is_company\": 0,\n \"title\": \"test_list_20220912\",\n \"contacts_count\": 46,\n \"deleted\": 0,\n \"prune_date\": null,\n \"keep_order_on_prune\": 1,\n \"pruned\": 0,\n \"updated_at\": \"2024-10-29T09:01:34.000Z\",\n \"created_at\": \"2022-09-12T11:47:13.000Z\"\n}"},{"id":"ed0d4503-2d27-4c7b-8e08-e9c570723daa","name":"View all contactlsits","originalRequest":{"method":"GET","header":[],"url":"{your_dialer}.hitrate.tech:3007/api/contactlist"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"4463"},{"key":"etag","value":"W/\"116f-aY/B3Ms4LkZc0saLE+Yhw2vJUkw\""},{"key":"date","value":"Mon, 11 Nov 2024 08:15:32 GMT"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 6,\n \"office_id\": null,\n \"is_company\": 0,\n \"title\": \"Nykund - Tidigare utfall\",\n \"contacts_count\": 0,\n \"deleted\": 0,\n \"prune_date\": null,\n \"keep_order_on_prune\": 1,\n \"pruned\": 0,\n \"updated_at\": \"2023-12-12T07:39:16.000Z\",\n \"created_at\": \"2023-12-12T07:39:16.000Z\"\n },\n {\n \"id\": 22,\n \"office_id\": null,\n \"is_company\": 0,\n \"title\": \"Mäklare\",\n \"contacts_count\": 36,\n \"deleted\": 0,\n \"prune_date\": null,\n \"keep_order_on_prune\": 1,\n \"pruned\": 0,\n \"updated_at\": \"2023-12-13T10:21:05.000Z\",\n \"created_at\": \"2023-12-13T10:21:04.000Z\"\n },\n {\n \"id\": 26,\n \"office_id\": null,\n \"is_company\": 0,\n \"title\": \"Mäklare2\",\n \"contacts_count\": 36,\n \"deleted\": 0,\n \"prune_date\": null,\n \"keep_order_on_prune\": 1,\n \"pruned\": 0,\n \"updated_at\": \"2023-12-13T10:51:49.000Z\",\n \"created_at\": \"2023-12-13T10:51:49.000Z\"\n },\n {\n \"id\": 34,\n \"office_id\": 10,\n \"is_company\": 0,\n \"title\": \"test_list_20240912\",\n \"contacts_count\": 46,\n \"deleted\": 0,\n \"prune_date\": null,\n \"keep_order_on_prune\": 1,\n \"pruned\": 0,\n \"updated_at\": \"2024-10-29T09:01:34.000Z\",\n \"created_at\": \"2024-09-12T11:47:13.000Z\"\n }\n {\n \"id\": 55,\n \"office_id\": null,\n \"is_company\": 0,\n \"title\": \"copy_20240926\",\n \"contacts_count\": 12716,\n \"deleted\": 0,\n \"prune_date\": null,\n \"keep_order_on_prune\": 1,\n \"pruned\": 0,\n \"updated_at\": \"2024-09-26T13:27:59.000Z\",\n \"created_at\": \"2024-09-26T13:23:15.000Z\"\n }\n]"},{"id":"6db4217e-77ef-459d-869f-5db069cd5fa0","name":"Invalid format","originalRequest":{"method":"GET","header":[],"url":{"raw":"{your_dialer}.hitrate.tech:3007/api/contactlist/:id","host":["{your_dialer}.hitrate.tech"],"port":"3007","path":["api","contactlist",":id"],"variable":[{"key":"id","value":"a"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"31"},{"key":"etag","value":"W/\"1f-ElQmEbiAwyO8cJsSwuy4fjnpttY\""},{"key":"date","value":"Mon, 11 Nov 2024 08:15:18 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Invalid ID format\"\n}"}],"_postman_id":"2b9ef3ea-062b-4faa-838c-c84968af4c11"},{"name":"View customfields","id":"a46d83e2-1a7e-49da-aa22-626ce12d624c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{API token}"}]},"isInherited":false},"method":"GET","header":[],"url":"{your_dialer}.hitrate.tech:3007/api/customfield","description":"Custom fields are extra data objects that users can specify for each dialer.
\nThis endpoint lists all customfields that are availble to be stored as well as what datatype they are.
\nType 1 are customer card custom fields.
\nType 2 are product custom fields (only created when creating an order).
\nFor type 2 custom fields, refer to product custom fields API for their specific datatypes.
\n","urlObject":{"port":"3007","path":["api","customfield"],"host":["{your_dialer}.hitrate.tech"],"query":[],"variable":[]}},"response":[{"id":"bc907bfb-afcd-4752-bae0-ddddfe37a55c","name":"Success","originalRequest":{"method":"GET","header":[],"url":"https://{{Dialer URL}}:3007/api/customfield"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"10783"},{"key":"etag","value":"W/\"2a1f-fQCr/GNqLPIOT5j1cZaAFoWQR9s\""},{"key":"date","value":"Fri, 19 Jan 2024 14:34:21 GMT"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 1,\n \"name\": \"Housetype\",\n \"datatype\": \"string\",\n \"default_value\": null,\n \"options\": null,\n \"type\": 2,\n \"description\": \"Apartment, house, condimunium\",\n \"deleted\": 0\n },\n {\n \"id\": 2,\n \"name\": \"Standard\",\n \"datatype\": \"int\",\n \"default_value\": \"12\",\n \"options\": null,\n \"type\": 1,\n \"description\": \"A dozen\",\n \"deleted\": 0\n },{\n \"id\": 9,\n \"name\": \"EnRich - for Dogs\",\n \"datatype\": \"multi\",\n \"default_value\": null,\n \"options\": \"{\\\"cols\\\":[\\\"Taste\\\",\\\"Order text\\\",\\\"Weight\\\",\\\"Shipping\\\"],\\\"values\\\":[[\\\"Chicken - small\\\",\\\"Chicken_dog_small\\\",\\\"500g\\\",\\\"39SEK\\\"],[\\\"Chicken - large\\\",\\\"Chicken_dog_large\\\",\\\"2000g\\\",\\\"79SEK\\\"],[\\\"Beef - small\\\",\\\"Beef_dog_small\\\",\\\"500g\\\",\\\"39SEK\\\"],[\\\"Beef - large\\\",\\\"Beef_dog_large\\\",\\\"2000g\\\",\\\"79SEK\\\"],[\\\"Pork - small\\\",\\\"Pork_dog_small\\\",\\\"750g\\\",\\\"25SEK\\\"],[\\\"Pork - large\\\",\\\"Pork_dog_large\\\",\\\"3000g\\\",\\\"69SEK\\\"]],\\\"disabled\\\":{\\\"values\\\":[0,1,3,2]}}\",\n \"type\": 2,\n \"description\": null,\n \"deleted\": 0\n },\n {\n \"id\": 13,\n \"name\": \"Long text api test\",\n \"datatype\": \"text\",\n \"default_value\": null,\n \"options\": null,\n \"type\": 1,\n \"description\": null,\n \"deleted\": 0\n },\n {\n \"id\": 14,\n \"name\": \"Member\",\n \"datatype\": \"boolean\",\n \"default_value\": \"No\",\n \"options\": null,\n \"type\": 1,\n \"description\": null,\n \"deleted\": 1\n },\n {\n \"id\": 15,\n \"name\": \"Status\",\n \"datatype\": \"datetime\",\n \"default_value\": null,\n \"options\": null,\n \"type\": 1,\n \"description\": null,\n \"deleted\": 0\n },\n {\n \"id\": 16,\n \"name\": \"Contract start\",\n \"datatype\": \"date\",\n \"default_value\": null,\n \"options\": null,\n \"type\": 1,\n \"description\": null,\n \"deleted\": 1\n },\n {\n \"id\": 17,\n \"name\": \"Phone operator\",\n \"datatype\": \"dropdown\",\n \"default_value\": null,\n \"options\": \"Telia;;Telenor;;Tele2;;Hi3g;;Other\",\n \"type\": 1,\n \"description\": null,\n \"deleted\": 0\n }\n]"}],"_postman_id":"a46d83e2-1a7e-49da-aa22-626ce12d624c"},{"name":"Create blocklist","id":"5b2c2129-8bd2-4aef-b8d3-96a235fdee4a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"title\": str\r\n}","options":{"raw":{"language":"json"}}},"url":"{your_dialer}.hitrate.tech:3007/api/blocklist","description":"Create a blocklist to be used by the campaigns in the dialer. Blocklists prevent customers who match the blocklist on a campaign to be called.
\nBlocklists can be used in two ways:
\nEnable them on a campaign and all customers on the blocklist will not be able to be called. Any customers that already has been called or has planned calls will be stopped.
\nSelect the blocklist when adding a contactlist in the system and they are removed from the contactlist entirely.
\nGet a list of all created blocklists on a dialer.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{API token}"}]},"isInherited":true,"source":{"_postman_id":"023d17ad-66f9-41ca-b576-cc71fb619feb","id":"023d17ad-66f9-41ca-b576-cc71fb619feb","name":"HitrateAPI 1.4.4","type":"collection"}},"urlObject":{"port":"3007","path":["api","blocklist"],"host":["{your_dialer}.hitrate.tech"],"query":[],"variable":[]}},"response":[{"id":"a3342eef-1ce1-46f7-b5ce-66e440eb6c8b","name":"Success","originalRequest":{"method":"GET","header":[],"url":"https://{{Dialer URL}}:3007/api/blocklist"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"94"},{"key":"etag","value":"W/\"5e-NoOvdVYDwgeLd5gqJklehg8frtA\""},{"key":"date","value":"Thu, 18 Jan 2024 12:49:26 GMT"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 1,\n \"title\": \"Universal black list\",\n \"count\": 0\n },\n {\n \"id\": 2,\n \"title\": \"new blocklist\",\n \"count\": 0\n }\n]"}],"_postman_id":"5e86bee4-4c52-4cc4-b1ba-8cedf71563f9"},{"name":"Add number to blocklist","id":"e638616a-a479-4eaa-9dc7-0149d7167d56","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"id\": int,\r\n \"phone\": str,\r\n \"end_date\": date,\r\n \"comment\": str\r\n}","options":{"raw":{"language":"json"}}},"url":"{your_dialer}.hitrate.tech:3007/api/blocklist/customer","description":"Add a number along with a comment to a blocklist.
\nEnd date is used to set a time for when the number is okay to call again. This will not affect any numbers that got removed from a contactlist import where blocklist filtering was used, only future contactlists or customers on a campaign in an active contactlist.
\nComments and end date are optional.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{API token}"}]},"isInherited":true,"source":{"_postman_id":"023d17ad-66f9-41ca-b576-cc71fb619feb","id":"023d17ad-66f9-41ca-b576-cc71fb619feb","name":"HitrateAPI 1.4.4","type":"collection"}},"urlObject":{"port":"3007","path":["api","blocklist","customer"],"host":["{your_dialer}.hitrate.tech"],"query":[],"variable":[]}},"response":[{"id":"df3373d9-b089-4ec8-97a6-749a40ee08c6","name":"Creation success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"id\": 2,\r\n \"phone\": \"076xxxxxxx\",\r\n \"comment\": \"Existing customer\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{Dialer URL}}:3007/api/blocklist/customer"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"27"},{"key":"etag","value":"W/\"1b-HxLDO9fzophHENWXYBOKVtZK/2U\""},{"key":"date","value":"Thu, 18 Jan 2024 14:20:12 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"id\": 1\n}"},{"id":"220cb26f-94d1-43bf-a1a8-1fd74925c0e3","name":"Creation with end date success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"id\": 6,\r\n \"phone\": \"+46768085162\",\r\n \"end_date\": \"2024-07-27\",\r\n \"comment\": \"Nej\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{your_dialer}.hitrate.tech:3007/api/blocklist/customer"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"29"},{"key":"etag","value":"W/\"1d-xan+TvMeJ81oUya05OG2engs4tA\""},{"key":"date","value":"Thu, 03 Jul 2025 13:37:21 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"id\": 182\n}"},{"id":"d952417d-ae46-4bcf-ab7e-40d716b16c38","name":"Invalid format on a parameter","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{your_dialer}.hitrate.tech:3007/api/blocklist/customer"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"31"},{"key":"etag","value":"W/\"1f-ElQmEbiAwyO8cJsSwuy4fjnpttY\""},{"key":"date","value":"Thu, 03 Jul 2025 13:25:37 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Invalid ID format\"\n}"},{"id":"e1e841bc-c9d5-4ff8-861a-aab7703140dd","name":"Comment field missing","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"id\": 6,\r\n \"phone\": \"076xxxxxxx\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{your_dialer}.hitrate.tech:3007/api/blocklist/customer"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"44"},{"key":"etag","value":"W/\"2c-NhunD3qwBeposCsVuzAhnhRQfxQ\""},{"key":"date","value":"Thu, 03 Jul 2025 13:26:11 GMT"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"message\": \"comment field must be provided\"\n}"},{"id":"45e5dc30-cae1-4999-b3cf-35bd862bde75","name":"Duplicate number in blocklist","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"id\": 6,\r\n \"phone\": \"+4676xxxxxxx\",\r\n \"comment\": \"Said no like 5 times\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{your_dialer}.hitrate.tech:3007/api/blocklist/customer"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"115"},{"key":"etag","value":"W/\"73-lbahe2xFa6+40Fyup6wZq2MJ1j0\""},{"key":"date","value":"Thu, 03 Jul 2025 13:48:42 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": \"Server Error\",\n \"message\": \"Duplicate entry '6-+46768085162' for key 'unique_nixlist_item'\"\n}"}],"_postman_id":"e638616a-a479-4eaa-9dc7-0149d7167d56"},{"name":"Delete blocklist","id":"e3040a3f-2096-4421-aec9-a6f44918386d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\r\n \"id\": int\r\n}","options":{"raw":{"language":"json"}}},"url":"{your_dialer}.hitrate.tech:3007/api/blocklist","description":"Removes a blocklist, this will allow campaigns to make calls to customers that were on the deleted blocklist.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{API token}"}]},"isInherited":true,"source":{"_postman_id":"023d17ad-66f9-41ca-b576-cc71fb619feb","id":"023d17ad-66f9-41ca-b576-cc71fb619feb","name":"HitrateAPI 1.4.4","type":"collection"}},"urlObject":{"port":"3007","path":["api","blocklist"],"host":["{your_dialer}.hitrate.tech"],"query":[],"variable":[]}},"response":[{"id":"360396e2-fe45-4828-b1fa-05cd2d7e659c","name":"Success","originalRequest":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\r\n \"id\": 2\r\n}","options":{"raw":{"language":"json"}}},"url":"{your_dialer}.hitrate.tech:3007/api/blocklist"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"16"},{"key":"etag","value":"W/\"10-oV4hJxRVSENxc/wX8+mA4/Pe4tA\""},{"key":"date","value":"Thu, 19 Jun 2025 14:03:45 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true\n}"},{"id":"94baa9c3-31cd-4460-b45b-116ba24f9cf7","name":"Blocklist not found","originalRequest":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\r\n \"id\": 54\r\n}","options":{"raw":{"language":"json"}}},"url":"{your_dialer}.hitrate.tech:3007/api/blocklist"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"31"},{"key":"etag","value":"W/\"1f-h+lppdk7adqxoY/PUzkHKLOVsvw\""},{"key":"date","value":"Thu, 03 Jul 2025 13:34:10 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Nixlist not found\"\n}"}],"_postman_id":"e3040a3f-2096-4421-aec9-a6f44918386d"},{"name":"Delete number on list","id":"780ec71e-e7b1-4583-a6e6-fa6500fc0737","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\r\n \"id\": int,\r\n \"phone\" : str\r\n}","options":{"raw":{"language":"json"}}},"url":"{your_dialer}.hitrate.tech:3007/api/blocklist/customer","description":"Deletes a specific number on a blocklist.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{API token}"}]},"isInherited":true,"source":{"_postman_id":"023d17ad-66f9-41ca-b576-cc71fb619feb","id":"023d17ad-66f9-41ca-b576-cc71fb619feb","name":"HitrateAPI 1.4.4","type":"collection"}},"urlObject":{"port":"3007","path":["api","blocklist","customer"],"host":["{your_dialer}.hitrate.tech"],"query":[],"variable":[]}},"response":[{"id":"ab8acf4f-1916-41f6-9d66-a28b85220ce8","name":"Number deleted","originalRequest":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\r\n \"id\": 6,\r\n \"phone\" : \"+467XXXXXXXX\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{your_dialer}.hitrate.tech:3007/api/blocklist/customer"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"16"},{"key":"etag","value":"W/\"10-oV4hJxRVSENxc/wX8+mA4/Pe4tA\""},{"key":"date","value":"Thu, 19 Jun 2025 14:07:38 GMT"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"success\": true\n}"},{"id":"740f9d8d-7e43-45d1-8e99-4b72a9a53934","name":"Number not found","originalRequest":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\r\n \"id\": 6,\r\n \"phone\" : \"+467XXXXXXXX\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{your_dialer}.hitrate.tech:3007/api/blocklist/customer"},"status":"Not Found","code":404,"_postman_previewlanguage":"html","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"text/html; charset=utf-8"},{"key":"content-length","value":"22"},{"key":"etag","value":"W/\"16-5z11GwtGYO56yj7DzCIlhN6lzJM\""},{"key":"date","value":"Thu, 19 Jun 2025 14:08:15 GMT"}],"cookie":[],"responseTime":null,"body":"Nixlist item not found"}],"_postman_id":"780ec71e-e7b1-4583-a6e6-fa6500fc0737"}],"id":"58657342-96b3-46f2-aa7e-1154e7814a9c","description":"The system seperates customers into different contactlists. These are used to split customers up between campaigns to control when and how customers in a contactlist are contacted.
\nAll contactlists come with some standardized fields for storing data. If these fields aren't sufficient, users can add their own custom fields which can be used to store more data.
\nStandard fields:
\nFirst name
\nLast name
\nIdentity number
\nPhone
\nAddress
\nPostal code
\nCity
\nCompany name
\nOrganization number
\nExtrernal id 1-3
\nCreates a new customer save them to a specific contactlist
\nAllow_duplicates - allows/stops the same customer to exist on the same list (thus allowing it to be called twice). If you are integratin an CRM or similar you can keep this active.
\nContactlist_duplicates - checks and stops the customer from being created if it already exists in another contactlist specified
\nThe amount of custom_fields that can be added in a request isn't limited
\nearliest_ringtime - specify a date, customer will not be contacted until after this date.
\nAny field that isn't neccessary can be omitted and the customer will still be created.
\n*list_id and phone are mandatory fields
\n","urlObject":{"port":"3007","path":["api","customer"],"host":["{your_dialer}.hitrate.tech"],"query":[],"variable":[]}},"response":[{"id":"97008cbd-6ad5-4aea-aa30-46e1bda6c389","name":"New customer success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"list_id\": 6,\r\n \"allow_duplicates\": true,\r\n \"phone\": \"+4676xxxxxxx\",\r\n \"first_name\": \"Test\", \r\n \"last_name\": \"Testisson\", \r\n \"identity_number\": \"19720311-1234\", \r\n \"address\": \"Tester street 11\", \r\n \"postal_code\": \"44444\", \r\n \"city\": \"Cityburg\"\r\n}"},"url":"{your_dialer}.hitrate.tech:3007/api/customer"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"61"},{"key":"etag","value":"W/\"3d-eS/cmzKky/zudoDIWMk5cCMxs9s\""},{"key":"date","value":"Thu, 03 Jul 2025 13:41:25 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Data inserted successfully\",\n \"customer_id\": 1694998\n}"},{"id":"dc85de21-9599-47c4-9ef7-37a1e82a9ae6","name":"Minimal customer creation success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"list_id\": 6,\r\n \"allow_duplicates\": true,\r\n \"phone\": \"+4676xxxxxxx\"\r\n}"},"url":"{your_dialer}.hitrate.tech:3007/api/customer"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"61"},{"key":"etag","value":"W/\"3d-oXhjj8/OP+xc3pX8hr8WllrG8K8\""},{"key":"date","value":"Thu, 03 Jul 2025 13:42:11 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Data inserted successfully\",\n \"customer_id\": 1695002\n}"},{"id":"b6849bfb-954c-498f-9fb5-241cfccfff42","name":"Customer with custom data success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"list_id\": 6,\r\n \"allow_duplicates\": true,\r\n \"phone\": \"+4676xxxxxxx\",\r\n \"first_name\": \"Test\", \r\n \"last_name\": \"Testisson\", \r\n \"identity_number\": \"19720311-1234\", \r\n \"address\": \"Tester street 11\", \r\n \"postal_code\": \"44444\", \r\n \"city\": \"Cityburg\",\r\n \"external_id_2\": 123,\r\n \"custom_field_6\": \"2023-01-12\",\r\n \"custom_field_10\": 127,\r\n \"custom_field_30\": \"Some custom value\"\r\n}"},"url":"{your_dialer}.hitrate.tech:3007/api/customer"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"61"},{"key":"etag","value":"W/\"3d-YPVXIZ9y8/FylOAt2JnK/5GL59k\""},{"key":"date","value":"Thu, 03 Jul 2025 13:45:49 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Data inserted successfully\",\n \"customer_id\": 1695190\n}"},{"id":"0efe2901-3ebc-42ac-a6c5-d00e21f262ff","name":"Error phone number is not valid","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"list_id\": 6,\r\n \"allow_duplicates\": true,\r\n \"first_name\": \"Test\", \r\n \"last_name\": \"Testisson\", \r\n \"identity_number\": \"19720311-1234\", \r\n \"address\": \"Tester street 11\", \r\n \"postal_code\": \"44444\", \r\n \"city\": \"Cityburg\",\r\n \"external_id_2\": 123,\r\n \"custom_field_6\": \"2023-01-12\",\r\n \"custom_field_10\": 127,\r\n \"custom_field_30\": \"Some custom value\"\r\n}"},"url":"{your_dialer}.hitrate.tech:3007/api/customer"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"47"},{"key":"etag","value":"W/\"2f-5JLgw8aEIQBIRizr5ihU0hfKg4s\""},{"key":"date","value":"Thu, 03 Jul 2025 13:46:43 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"customer phonenumber is not valid\"\n}"},{"id":"7d70aba7-72dd-4b51-97f3-31d034d4cae4","name":"Error found duplicate","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"list_id\": 6,\r\n \"phone\": \"+4676xxxxxxx\"\r\n}"},"url":"{your_dialer}.hitrate.tech:3007/api/customer"},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"31"},{"key":"etag","value":"W/\"1f-3y3hYI0WTtowioZlgeOrVPVycSQ\""},{"key":"date","value":"Thu, 03 Jul 2025 13:41:51 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Found duplication\"\n}"},{"id":"8d5c1811-1af2-4bd4-ac22-00c5f3ae29e4","name":"Error contaclist id missing","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"allow_duplicates\": true,\r\n \"phone\": \"+4676xxxxxxx\",\r\n \"first_name\": \"Test\", \r\n \"last_name\": \"Testisson\", \r\n \"identity_number\": \"19720311-1234\", \r\n \"address\": \"Tester street 11\", \r\n \"postal_code\": \"44444\", \r\n \"city\": \"Cityburg\",\r\n \"external_id_2\": 123,\r\n \"custom_field_6\": \"2023-01-12\",\r\n \"custom_field_10\": 127,\r\n \"custom_field_30\": \"Some custom value\"\r\n}"},"url":"{your_dialer}.hitrate.tech:3007/api/customer"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"37"},{"key":"etag","value":"W/\"25-/WcWK0FYl3tQK6RpUIpOTbnmzqk\""},{"key":"date","value":"Thu, 03 Jul 2025 13:47:40 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"list_id field not found\"\n}"}],"_postman_id":"9b68f670-94ad-4493-a78b-222d297ebd52"},{"name":"Create multiple customers","id":"7680c9f7-1dfb-48ae-b000-935951a06286","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true},"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{API token}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"list_id\": int,\r\n \"allow_duplicates\": boolean,\r\n \"contactlist_duplicates\": list[int],\r\n \"data\":[\r\n {\r\n \"phone\": str,\r\n \"earliest_ringtime\": date,\r\n \"first_name\": str, \r\n \"last_name\": str, \r\n \"identity_number\": str, \r\n \"email\": str, \r\n \"address\": str, \r\n \"postal_code\": str, \r\n \"city\": str, \r\n \"external_id_1\": str, \r\n \"external_id_2\": str, \r\n \"external_id_3\": str,\r\n \"custom_field_{id}\": str\r\n }\r\n ]\r\n}"},"url":"{your_dialer}.hitrate.tech:3007/api/customers","description":"Creates multiple new customer and saves them to a specific contactlist
\nAllow_duplicates - allows/stops the same customer to exist on the same list (thus allowing it to be called twice)
\nContactlist_duplicates - checks and stops the customer from being created if it already exists in another contactlist specified
\nThe amount of custom_fields that can be added in a request isn't limited
\nearliest_ringtime - specify a date, customer will not be contacted until after this date.
\nThe requests are limited to 5000 customers or 10MB payload.
\nAny field that isn't neccessary can be omitted and the customer will still be created.
\nAll customers that didn't get saved will be included in the response body under the reason why they weren't saved. This is usually:
\nMisisng or faulty phonenumber
\nDuplicate match
\nThere was missing keys or data with wrong format
\n*list_id and phone are mandatory fields
\n","urlObject":{"port":"3007","path":["api","customers"],"host":["{your_dialer}.hitrate.tech"],"query":[],"variable":[]}},"response":[{"id":"0716b08f-9171-4a10-874c-7feeee5ced07","name":"Create multiple customers success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"list_id\": 6,\r\n \"allow_duplicates\": true,\r\n \"data\":[\r\n {\r\n \"phone\": \"+4610xxxxxxx\",\r\n \"first_name\": \"Ignatius\", \r\n \"last_name\": \"Lowe\", \r\n \"email\": \"tortor.at.risus@google.couk\", \r\n \"address\": \"Ap #563-8366 Et Avenue\", \r\n \"postal_code\": \"694279\", \r\n \"city\": \"Loralai\",\r\n \"custom_field_30\": \"rental aprtment\"\r\n },\r\n {\r\n \"phone\": \"+4631xxxxxxx\",\r\n \"first_name\": \"Baker\", \r\n \"last_name\": \"Shepherd\", \r\n \"email\": \"nulla@outlook.edu\", \r\n \"address\": \"Ap #897-7840 Dictum Ave\", \r\n \"postal_code\": \"44351\", \r\n \"city\": \"Cork\",\r\n \"custom_field_30\": \"rental aprtment\"\r\n },\r\n {\r\n \"phone\": \"+4642xxxxxxx\",\r\n \"first_name\": \"Tiger\", \r\n \"last_name\": \"Puckett\", \r\n \"email\": \"mi.pede.nonummy@outlook.edu\", \r\n \"address\": \"Ap #404-7623 Aliquam Ave\", \r\n \"postal_code\": \"26544\", \r\n \"city\": \"Cedar Rapids\",\r\n \"custom_field_30\": \"condimunium\"\r\n }\r\n ]\r\n}"},"url":"{your_dialer}.hitrate.tech:3007/api/customers"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"1006"},{"key":"etag","value":"W/\"3ee-r3TEmEdeJD6XkpfZ/E5ufNqB1yU\""},{"key":"date","value":"Thu, 03 Jul 2025 14:09:13 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"illegal_phone\": [],\n \"filtered_duplicates\": [],\n \"success_insert\": [\n {\n \"phone\": \"+4610xxxxxxx\",\n \"first_name\": \"Ignatius\",\n \"last_name\": \"Lowe\",\n \"email\": \"tortor.at.risus@google.couk\",\n \"address\": \"Ap #563-8366 Et Avenue\",\n \"postal_code\": \"694279\",\n \"city\": \"Loralai\",\n \"earliest_ringtime\": null,\n \"custom_fields\": [\n {\n \"id\": 30,\n \"value\": \"rental aprtment\"\n }\n ],\n \"phonenumber\": \"+4610xxxxxxx\",\n \"customer_id\": 1695934\n },\n {\n \"phone\": \"+4631xxxxxxx\",\n \"first_name\": \"Baker\",\n \"last_name\": \"Shepherd\",\n \"email\": \"nulla@outlook.edu\",\n \"address\": \"Ap #897-7840 Dictum Ave\",\n \"postal_code\": \"44351\",\n \"city\": \"Cork\",\n \"earliest_ringtime\": null,\n \"custom_fields\": [\n {\n \"id\": 30,\n \"value\": \"rental aprtment\"\n }\n ],\n \"phonenumber\": \"+4631xxxxxxx\",\n \"customer_id\": 1695938\n },\n {\n \"phone\": \"+4642xxxxxxx\",\n \"first_name\": \"Tiger\",\n \"last_name\": \"Puckett\",\n \"email\": \"mi.pede.nonummy@outlook.edu\",\n \"address\": \"Ap #404-7623 Aliquam Ave\",\n \"postal_code\": \"26544\",\n \"city\": \"Cedar Rapids\",\n \"earliest_ringtime\": null,\n \"custom_fields\": [\n {\n \"id\": 30,\n \"value\": \"condimunium\"\n }\n ],\n \"phonenumber\": \"+4642xxxxxxx\",\n \"customer_id\": 1695942\n }\n ],\n \"failed_insert\": []\n}"},{"id":"f97b60f3-f75d-4867-acd0-dd4b70a769ad","name":"Duplicates and invalid phone numbers","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"list_id\": 6,\r\n \"allow_duplicates\": false,\r\n \"data\":[\r\n {\r\n \"phone\": \"+4610xxxxxxx\",\r\n \"first_name\": \"Ignatius\", \r\n \"last_name\": \"Lowe\", \r\n \"email\": \"tortor.at.risus@google.couk\", \r\n \"address\": \"Ap #563-8366 Et Avenue\", \r\n \"postal_code\": \"694279\", \r\n \"city\": \"Loralai\",\r\n \"custom_field_30\": \"rental aprtment\"\r\n },\r\n {\r\n \"phone\": \"+4631xxxxxxx\",\r\n \"first_name\": \"Baker\", \r\n \"last_name\": \"Shepherd\", \r\n \"email\": \"nulla@outlook.edu\", \r\n \"address\": \"Ap #897-7840 Dictum Ave\", \r\n \"postal_code\": \"44351\", \r\n \"city\": \"Cork\",\r\n \"custom_field_30\": \"rental aprtment\"\r\n },\r\n {\r\n \"phone\": \"+4642xxxxxxx\",\r\n \"first_name\": \"Tiger\", \r\n \"last_name\": \"Puckett\", \r\n \"email\": \"mi.pede.nonummy@outlook.edu\", \r\n \"address\": \"Ap #404-7623 Aliquam Ave\", \r\n \"postal_code\": \"26544\", \r\n \"city\": \"Cedar Rapids\",\r\n \"custom_field_30\": \"condimunium\"\r\n }\r\n ]\r\n}"},"url":"{your_dialer}.hitrate.tech:3007/api/customers"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"976"},{"key":"etag","value":"W/\"3d0-cpFywmj5ndvdYcueemGGtYBa1VI\""},{"key":"date","value":"Thu, 03 Jul 2025 14:14:38 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"illegal_phone\": [\n {\n \"phone\": \"+4642xxxxxxx\",\n \"first_name\": \"Tiger\",\n \"last_name\": \"Puckett\",\n \"email\": \"mi.pede.nonummy@outlook.edu\",\n \"address\": \"Ap #404-7623 Aliquam Ave\",\n \"postal_code\": \"26544\",\n \"city\": \"Cedar Rapids\",\n \"earliest_ringtime\": null,\n \"custom_fields\": [\n {\n \"id\": 30,\n \"value\": \"condimunium\"\n }\n ]\n }\n ],\n \"filtered_duplicates\": [\n {\n \"phone\": \"+4631xxxxxxx\",\n \"first_name\": \"Baker\",\n \"last_name\": \"Shepherd\",\n \"email\": \"nulla@outlook.edu\",\n \"address\": \"Ap #897-7840 Dictum Ave\",\n \"postal_code\": \"44351\",\n \"city\": \"Cork\",\n \"earliest_ringtime\": null,\n \"custom_fields\": [\n {\n \"id\": 30,\n \"value\": \"rental aprtment\"\n }\n ],\n \"phonenumber\": \"+4631xxxxxxx\",\n \"duplcates\": [\n {\n \"contactlist_id\": 6,\n \"nr\": 1\n }\n ]\n }\n ],\n \"success_insert\": [\n {\n \"phone\": \"+4610xxxxxxx\",\n \"first_name\": \"Ignatius\",\n \"last_name\": \"Lowe\",\n \"email\": \"tortor.at.risus@google.couk\",\n \"address\": \"Ap #563-8366 Et Avenue\",\n \"postal_code\": \"694279\",\n \"city\": \"Loralai\",\n \"earliest_ringtime\": null,\n \"custom_fields\": [\n {\n \"id\": 30,\n \"value\": \"rental aprtment\"\n }\n ],\n \"phonenumber\": \"+4610xxxxxxx\",\n \"customer_id\": 1696130\n }\n ],\n \"failed_insert\": []\n}"},{"id":"0f0d9be1-044a-48a4-8fda-a51c8088fd8d","name":"contactlist_id is missing","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"allow_duplicates\": false,\r\n \"data\":[\r\n {\r\n \"phone\": \"+46102886103\",\r\n \"first_name\": \"Ignatius\", \r\n \"last_name\": \"Lowe\", \r\n \"email\": \"tortor.at.risus@google.couk\", \r\n \"address\": \"Ap #563-8366 Et Avenue\", \r\n \"postal_code\": \"694279\", \r\n \"city\": \"Loralai\",\r\n \"custom_field_30\": \"rental aprtment\"\r\n },\r\n {\r\n \"phone\": \"+46313771830\",\r\n \"first_name\": \"Baker\", \r\n \"last_name\": \"Shepherd\", \r\n \"email\": \"nulla@outlook.edu\", \r\n \"address\": \"Ap #897-7840 Dictum Ave\", \r\n \"postal_code\": \"44351\", \r\n \"city\": \"Cork\",\r\n \"custom_field_30\": \"rental aprtment\"\r\n },\r\n {\r\n \"phone\": \"+46424424313332\",\r\n \"first_name\": \"Tiger\", \r\n \"last_name\": \"Puckett\", \r\n \"email\": \"mi.pede.nonummy@outlook.edu\", \r\n \"address\": \"Ap #404-7623 Aliquam Ave\", \r\n \"postal_code\": \"26544\", \r\n \"city\": \"Cedar Rapids\",\r\n \"custom_field_30\": \"condimunium\"\r\n }\r\n ]\r\n}"},"url":"{your_dialer}.hitrate.tech:3007/api/customers"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"38"},{"key":"etag","value":"W/\"26-1nPHSyu9+9/cRZUFj0FUZUkzNEk\""},{"key":"date","value":"Thu, 03 Jul 2025 14:19:54 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"list_id must be provided\"\n}"}],"_postman_id":"7680c9f7-1dfb-48ae-b000-935951a06286"},{"name":"Get customer","id":"f1c964f2-d423-44e7-9a71-5ea2ba4925f7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{API token}"}]},"isInherited":false},"method":"GET","header":[],"url":"{your_dialer}.hitrate.tech:3007/api/customer?id={num}&phone={num}&external_id_{{num}}={num}","description":"Grab customer info based on customer_id or search customer based on external_id or phone number.
\nData returned as a json object with associated orders ID in an array.
\n","urlObject":{"port":"3007","path":["api","customer"],"host":["{your_dialer}.hitrate.tech"],"query":[{"description":{"content":"customer's id to search for. Has priority over phone & external_id
\n","type":"text/plain"},"key":"id","value":"{num}"},{"description":{"content":"Phone number, matches on most recent customer
\n","type":"text/plain"},"key":"phone","value":"{num}"},{"description":{"content":"Id from external system. Use to easier grab relevant customers from external systems
\n","type":"text/plain"},"key":"external_id_{{num}}","value":"{num}"}],"variable":[]}},"response":[{"id":"f5581a09-7db1-47b9-ba9b-a0115cad8e33","name":"Found customer","originalRequest":{"method":"GET","header":[],"url":{"raw":"{your_dialer}.hitrate.tech:3007/api/customer?id=1696326&phone=&external_id_{{num}}=","host":["{your_dialer}.hitrate.tech"],"port":"3007","path":["api","customer"],"query":[{"key":"id","value":"1696326","description":"customer's id to search for. Has priority over phone & external_id"},{"key":"phone","value":"","description":"Phone number, matches on most recent customer"},{"key":"external_id_{{num}}","value":"","description":"Id from external system. Use to easier grab relevant customers from external systems"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"423"},{"key":"etag","value":"W/\"1a7-7NSR18f2A1y8LlESCLCX28RVJ+4\""},{"key":"date","value":"Thu, 03 Jul 2025 14:21:50 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"customer_id\": 1696326,\n \"identity_number\": null,\n \"external_id_1\": null,\n \"external_id_2\": null,\n \"external_id_3\": null,\n \"city\": \"Loralai\",\n \"postal_code\": \"694279\",\n \"phone\": \"+4610xxxxxxx\",\n \"address\": \"Ap #563-8366 Et Avenue\",\n \"name\": \"Ignatius Lowe\",\n \"order_ids\": [],\n \"custom_fields\": [\n {\n \"title\": \"Status för ansökan\",\n \"custom_field_id\": 30,\n \"value\": \"rental apartment\"\n }\n ],\n \"create_time\": \"2025-07-03T14:20:35.000Z\",\n \"contactlist_ids\": [\n 5555\n ],\n \"call_ids\": []\n}"},{"id":"34390159-86ec-4dca-bf54-62296e11e9df","name":"No parameters used","originalRequest":{"method":"GET","header":[],"url":{"raw":"{your_dialer}.hitrate.tech:3007/api/customer?id=&phone=&external_id_{{num}}=","host":["{your_dialer}.hitrate.tech"],"port":"3007","path":["api","customer"],"query":[{"key":"id","value":"","description":"customer's id to search for. Has priority over phone & external_id"},{"key":"phone","value":"","description":"Phone number, matches on most recent customer"},{"key":"external_id_{{num}}","value":"","description":"Id from external system. Use to easier grab relevant customers from external systems"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"40"},{"key":"etag","value":"W/\"28-NSpz2+Z5Zcz3QtGOszxFKDuJA4g\""},{"key":"date","value":"Fri, 04 Jul 2025 13:15:47 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Query parameters are empty\"\n}"},{"id":"07214803-7070-401b-bfb6-3da7b5b760fb","name":"Customer not found","originalRequest":{"method":"GET","header":[],"url":{"raw":"{your_dialer}.hitrate.tech:3007/api/customer?id=1234544&phone=&external_id_{{num}}=","host":["{your_dialer}.hitrate.tech"],"port":"3007","path":["api","customer"],"query":[{"key":"id","value":"1234544","description":"customer's id to search for. Has priority over phone & external_id"},{"key":"phone","value":"","description":"Phone number, matches on most recent customer"},{"key":"external_id_{{num}}","value":"","description":"Id from external system. Use to easier grab relevant customers from external systems"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"32"},{"key":"etag","value":"W/\"20-TCdLIwne6vdEyHthj1VwutOB3Kg\""},{"key":"date","value":"Fri, 04 Jul 2025 13:16:08 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Customer not found\"\n}"},{"id":"6eeae239-c4c6-4015-b169-51e04c143516","name":"Search on phone","originalRequest":{"method":"GET","header":[],"url":{"raw":"{your_dialer}.hitrate.tech:3007/api/customer?id=&phone=076xxxxxxx&external_id_{{num}}=","host":["{your_dialer}.hitrate.tech"],"port":"3007","path":["api","customer"],"query":[{"key":"id","value":"","description":"customer's id to search for. Has priority over phone & external_id"},{"key":"phone","value":"076xxxxxxx","description":"Phone number, matches on most recent customer"},{"key":"external_id_{{num}}","value":"","description":"Id from external system. Use to easier grab relevant customers from external systems"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"553"},{"key":"etag","value":"W/\"229-GlHBLI+g66Qxe0yTV5bdSZrB5J0\""},{"key":"date","value":"Fri, 04 Jul 2025 13:22:05 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"customer_id\": 1695190,\n \"identity_number\": \"19720311-1234\",\n \"external_id_1\": null,\n \"external_id_2\": \"123\",\n \"external_id_3\": null,\n \"city\": \"Cityburg\",\n \"postal_code\": \"44444\",\n \"phone\": \"+4676xxxxxxx\",\n \"address\": \"Tester street 11\",\n \"name\": \"Test Testisson\",\n \"order_ids\": [],\n \"custom_fields\": [\n {\n \"title\": \"Ansökningsdatum\",\n \"custom_field_id\": 6,\n \"value\": \"2023-01-12\"\n },\n {\n \"title\": \"Belopp\",\n \"custom_field_id\": 10,\n \"value\": \"127\"\n },\n {\n \"title\": \"Status för ansökan\",\n \"custom_field_id\": 30,\n \"value\": \"Some custom value\"\n }\n ],\n \"create_time\": \"2025-07-03T13:45:49.000Z\",\n \"contactlist_ids\": [\n 6\n ],\n \"call_ids\": []\n}"}],"_postman_id":"f1c964f2-d423-44e7-9a71-5ea2ba4925f7"},{"name":"Move customer between contactlists","id":"0029d029-81dc-4635-8963-71a79b4a8916","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"customer_id\": 2,\r\n \"contactlist_id_from\": 6,\r\n \"contactlist_id_to\": 6\r\n}","options":{"raw":{"language":"json"}}},"url":"{your_dialer}.hitrate.tech:3007/api/customer/contactlist","description":"Moves a customer from one contactlist to a new one. Any campaigns that include the old contactlist will have the customer removed from call queue until the customer is added again or called manually.
\nAny calls on the old contactlist will remain if the customer were to get moved back.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{API token}"}]},"isInherited":true,"source":{"_postman_id":"023d17ad-66f9-41ca-b576-cc71fb619feb","id":"023d17ad-66f9-41ca-b576-cc71fb619feb","name":"HitrateAPI 1.4.4","type":"collection"}},"urlObject":{"port":"3007","path":["api","customer","contactlist"],"host":["{your_dialer}.hitrate.tech"],"query":[],"variable":[]}},"response":[{"id":"af2e3f9b-2a84-41f6-9901-27675495aaf2","name":"Customer doesn't exist on this contactlist","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"customer_id\": 2,\r\n \"contactlist_id_from\": 6,\r\n \"contactlist_id_to\": 2\r\n}","options":{"raw":{"language":"json"}}},"url":"{your_dialer}.hitrate.tech:3007/api/customer/contactlist"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"109"},{"key":"etag","value":"W/\"6d-WulvuLLJRcsaTildUiH0y0TOl1k\""},{"key":"date","value":"Thu, 03 Jul 2025 13:00:28 GMT"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"success\": false,\n \"message\": \"contactlist_customer could not be found with contactlist ID 6 and customer ID 2\"\n}"},{"id":"c4760495-c921-421b-8e19-c3cd216811b2","name":"Succesfully moved","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"customer_id\": 2,\r\n \"contactlist_id_from\": 2,\r\n \"contactlist_id_to\": 6\r\n}","options":{"raw":{"language":"json"}}},"url":"{your_dialer}.hitrate.tech:3007/api/customer/contactlist"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"77"},{"key":"etag","value":"W/\"4d-z2RJ7Was8SfQM0nmNrLvTAnXGGU\""},{"key":"date","value":"Thu, 03 Jul 2025 13:01:15 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"customer_id\": 2,\n \"contactlist_id_to\": 6,\n \"contactlist_id_from\": 2,\n \"status\": \"ok\"\n}"},{"id":"4e72e3d8-5039-4982-b940-b2542ae55c13","name":"Contactlist not found","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"customer_id\": 2,\r\n \"contactlist_id_from\": 6,\r\n \"contactlist_id_to\": 24\r\n}","options":{"raw":{"language":"json"}}},"url":"{your_dialer}.hitrate.tech:3007/api/customer/contactlist"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"69"},{"key":"etag","value":"W/\"45-0iAA9MDgWV8tNmSMtqWiuo3/Vu4\""},{"key":"date","value":"Thu, 03 Jul 2025 13:01:40 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"message\": \"contactlist with ID 24 not found\"\n}"}],"_postman_id":"0029d029-81dc-4635-8963-71a79b4a8916"},{"name":"Update customer","id":"f8f23f7d-d494-44dd-8bcf-67f6a64e7e8d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{API token}"}]},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"phone\": str,\r\n \"earliest_ringtime\": date,\r\n \"first_name\": str, \r\n \"last_name\": str, \r\n \"identity_number\": str, \r\n \"email\": str, \r\n \"address\": str, \r\n \"postal_code\": str, \r\n \"city\": str, \r\n \"external_id_1\": str, \r\n \"external_id_2\": str, \r\n \"external_id_3\": str,\r\n \"custom_field_{id}\": str\r\n}"},"url":"{your_dialer}.hitrate.tech:3007/api/customer?id=&phone=&external_id_{1-3]=","description":"Update a customer based on their customer_id or search customer based on phone number or external_id and update their data.
\nNo field is obligatory and only new data is neccesary to be sent in the body, any ommited fields will keep their data as is.
\n","urlObject":{"port":"3007","path":["api","customer"],"host":["{your_dialer}.hitrate.tech"],"query":[{"description":{"content":"customer's id to search for. Has priority over phone & external_id
\n","type":"text/plain"},"key":"id","value":""},{"description":{"content":"Phone number, matches on most recent customer
\n","type":"text/plain"},"key":"phone","value":""},{"description":{"content":"Id from external system. Use to easier match relevant customers from external systems
\n","type":"text/plain"},"key":"external_id_{1-3]","value":""}],"variable":[]}},"response":[{"id":"2970487f-d7c2-4a8f-bfc8-0721bc8d78ab","name":"Customer updated","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"email\": \"info@alphapartner.se\",\r\n \"external_id_1\": 1267423,\r\n \"custom_field_3\": 12854\r\n}"},"url":{"raw":"https://{{Dialer URL}}:3007/api/customer?id=10000057454&phone=&external_id_{1-3]=","protocol":"https","host":["{{Dialer URL}}"],"port":"3007","path":["api","customer"],"query":[{"key":"id","value":"10000057454"},{"key":"phone","value":""},{"key":"external_id_{1-3]","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"38"},{"key":"etag","value":"W/\"26-ihQxzn9Kpm0PPfwyhpcDanSpBik\""},{"key":"date","value":"Fri, 03 Feb 2023 15:33:11 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"customer_id\": 10000057,\n \"status\": \"ok\"\n}"},{"id":"03571f97-44ca-4da6-b728-3dc15e9e5ae9","name":"Customer not found","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"first_name\": \"Test\"\r\n}"},"url":{"raw":"{your_dialer}.hitrate.tech:3007/api/customer?id=16951904&phone=&external_id_{1-3]=","host":["{your_dialer}.hitrate.tech"],"port":"3007","path":["api","customer"],"query":[{"key":"id","value":"16951904","description":"customer's id to search for. Has priority over phone & external_id"},{"key":"phone","value":"","description":"Phone number, matches on most recent customer"},{"key":"external_id_{1-3]","value":"","description":"Id from external system. Use to easier match relevant customers from external systems"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"41"},{"key":"etag","value":"W/\"29-G7t2+gF+SgB3jd8aGuqWYBFNO/o\""},{"key":"date","value":"Fri, 04 Jul 2025 13:28:48 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Customer could not be found\"\n}"}],"_postman_id":"f8f23f7d-d494-44dd-8bcf-67f6a64e7e8d"},{"name":"GDPR prune customer","id":"376e57bc-8834-4082-b3ae-da725e86536e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{API token}"}]},"isInherited":false},"method":"DELETE","header":[],"url":"{your_dialer}.hitrate.tech:3007/api/gdpr/customer?id={num}&phone={num}&external_id_{1-3]={num}","description":"Either grab by customer_id or search customer based on phone number or external_id. Once found customer data will be pruned and replaced with a \"GDPR REMOVED\" template.
\nOrder and call data will be left, but any personal information will be removed and replaced with the GDPR template.
\ncustomer's id to search for. Has priority over phone & external_id
\n","type":"text/plain"},"key":"id","value":"{num}"},{"description":{"content":"Phone number, matches on most recent customer
\n","type":"text/plain"},"key":"phone","value":"{num}"},{"description":{"content":"Id from external system. Use to easier match relevant customers from external systems
\n","type":"text/plain"},"key":"external_id_{1-3]","value":"{num}"}],"variable":[]}},"response":[{"id":"26ee02cc-cede-4eef-8f29-04ec213613c9","name":"Customer pruned","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://{{Dialer URL}}:3007/api/gdpr/customer?id=158200&phone=&external_id_{1-3]=","protocol":"https","host":["{{Dialer URL}}"],"port":"3007","path":["api","gdpr","customer"],"query":[{"key":"id","value":"158200"},{"key":"phone","value":""},{"key":"external_id_{1-3]","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"36"},{"key":"etag","value":"W/\"24-voPCFmMstCk/6B8ku3ujXQi3Y0o\""},{"key":"date","value":"Fri, 03 Feb 2023 15:12:10 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"customer_id\": 158200,\n \"status\": \"ok\"\n}"},{"id":"bbb632d6-0b5e-4cfd-bb62-332d9a146e19","name":"Not found","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{your_dialer}.hitrate.tech:3007/api/gdpr/customer?id=169632767&phone=&external_id_{1-3]=","host":["{your_dialer}.hitrate.tech"],"port":"3007","path":["api","gdpr","customer"],"query":[{"key":"id","value":"169632767","description":"customer's id to search for. Has priority over phone & external_id"},{"key":"phone","value":"","description":"Phone number, matches on most recent customer"},{"key":"external_id_{1-3]","value":"","description":"Id from external system. Use to easier match relevant customers from external systems"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"41"},{"key":"etag","value":"W/\"29-G7t2+gF+SgB3jd8aGuqWYBFNO/o\""},{"key":"date","value":"Fri, 04 Jul 2025 13:17:11 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Customer could not be found\"\n}"}],"_postman_id":"376e57bc-8834-4082-b3ae-da725e86536e"},{"name":"Remove customer from contactlist","id":"5126de4a-4637-40e4-8935-4ed83b2cf43e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"{your_dialer}.hitrate.tech:3007/api/customer?id={num}&phone={num}&external_id_{1-3]={num}","description":"Remove a customer from any campaigns and contactlists that they are apart of. They will be cleared from memory so any automatic calls to them will be removed. All data is saved and the customer can be added to new contactlists or be viewed in the dialer.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{API token}"}]},"isInherited":true,"source":{"_postman_id":"023d17ad-66f9-41ca-b576-cc71fb619feb","id":"023d17ad-66f9-41ca-b576-cc71fb619feb","name":"HitrateAPI 1.4.4","type":"collection"}},"urlObject":{"port":"3007","path":["api","customer"],"host":["{your_dialer}.hitrate.tech"],"query":[{"description":{"content":"customer's id to search for. Has priority over phone & external_id
\n","type":"text/plain"},"key":"id","value":"{num}"},{"description":{"content":"Phone number, matches on most recent customer
\n","type":"text/plain"},"key":"phone","value":"{num}"},{"description":{"content":"Id from external system. Use to easier match relevant customers from external systems
\n","type":"text/plain"},"key":"external_id_{1-3]","value":"{num}"}],"variable":[]}},"response":[{"id":"8fc82c01-1fb3-41a1-9320-d8a7c1e31836","name":"Removed from list succesfully","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://{{Dialer URL}}:3007/api/customer?id=&phone=0768085162&external_id_{1-3]=","protocol":"https","host":["{{Dialer URL}}"],"port":"3007","path":["api","customer"],"query":[{"key":"id","value":""},{"key":"phone","value":"0768085162"},{"key":"external_id_{1-3]","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"38"},{"key":"etag","value":"W/\"26-jAsVHNDICfxaZUmR3xdTD24UQf4\""},{"key":"date","value":"Wed, 06 Sep 2023 11:38:06 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"customer_id\": 10000553,\n \"status\": \"ok\"\n}"},{"id":"95e322f3-5dad-4f04-abae-067a8dcda83d","name":"Parameters are empty","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{your_dialer}.hitrate.tech:3007/api/customer?id=&phone=&external_id_{1-3]=","host":["{your_dialer}.hitrate.tech"],"port":"3007","path":["api","customer"],"query":[{"key":"id","value":"","description":"customer's id to search for. Has priority over phone & external_id"},{"key":"phone","value":"","description":"Phone number, matches on most recent customer"},{"key":"external_id_{1-3]","value":"","description":"Id from external system. Use to easier match relevant customers from external systems"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"40"},{"key":"etag","value":"W/\"28-NSpz2+Z5Zcz3QtGOszxFKDuJA4g\""},{"key":"date","value":"Fri, 04 Jul 2025 13:31:10 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Query parameters are empty\"\n}"},{"id":"46a5f3eb-3a86-469e-b0f7-ba8b6d7b139e","name":"Customer not found","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{your_dialer}.hitrate.tech:3007/api/customer?id=16951904&phone=&external_id_{1-3]=","host":["{your_dialer}.hitrate.tech"],"port":"3007","path":["api","customer"],"query":[{"key":"id","value":"16951904","description":"customer's id to search for. Has priority over phone & external_id"},{"key":"phone","value":"","description":"Phone number, matches on most recent customer"},{"key":"external_id_{1-3]","value":"","description":"Id from external system. Use to easier match relevant customers from external systems"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"41"},{"key":"etag","value":"W/\"29-G7t2+gF+SgB3jd8aGuqWYBFNO/o\""},{"key":"date","value":"Fri, 04 Jul 2025 13:31:32 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Customer could not be found\"\n}"}],"_postman_id":"5126de4a-4637-40e4-8935-4ed83b2cf43e"}],"id":"c8736cae-9abd-4d21-b9ae-5e94ccf16508","description":"Customers are individuas/companies saved onto different contactlists. These customers house data which are presented for agents on customer cards and stored in the system.
\nCustomers can exist on multiple contactlist and are tied to unique IDs for each contactlist they exist on.
Customer cards are unique to the phone number on a customer.
The data that is visible on the customer card are decided on campaign level. All data is still saved on the customer if it isn't put to use.
Search for orders and get all data returned.
\nOrders are returned in a list, for how these look see example or look at description for /api/order/{id}.
\nUser_id - Matches the user who created the order
\nCampaign_id - Matches the campaign where the order was placed
\nExact_date - Find orders during a specific date
\nStart_date & end_date - Find orders created within a specified interval
\nConfirm start_date & end_date - Find orders that were confirmed at a specific date
\nId - Find order based on customer_id for the order
\nPhonenumber - Find order created on a specific phonenumber
\nExternal_id_{1-3} - Find orders based on external_id
\nYou can use one or several of the parameters to find orders created.
\nConfirmed orders are orders that have passed validation checks, this is decided based on campaign and can vary. The confirm date may also be different from the order creation date.
\n","urlObject":{"port":"3007","path":["api","orders",""],"host":["{your_dialer}.hitrate.tech"],"query":[{"description":{"content":"Match on user who created the order
\n","type":"text/plain"},"key":"user_id","value":"int"},{"description":{"content":"Match on the campaign where the order was created
\n","type":"text/plain"},"key":"campaign_id","value":"int"},{"description":{"content":"Exact date order was palced
\n","type":"text/plain"},"key":"exact_date","value":"date"},{"description":{"content":"Start date for creation of order
\n","type":"text/plain"},"key":"start_date","value":"date"},{"description":{"content":"End date for creation of ordder
\n","type":"text/plain"},"key":"end_date","value":"date"},{"description":{"content":"Start date on when confirmation of order was placed, has higher priority than start_date
\n","type":"text/plain"},"key":"confirm_start_date","value":"date"},{"description":{"content":"End date on when confirmation of order was placed, has higher priority than end_date
\n","type":"text/plain"},"key":"confirm_end_date","value":"date"},{"description":{"content":"Match on exact order id
\n","type":"text/plain"},"key":"id","value":"int"},{"description":{"content":"Match on orders with specific phone numbers, all formats are supported. Results in E164 format
\n","type":"text/plain"},"key":"phone","value":"str"},{"description":{"content":"Match on customers with specific external id
\n","type":"text/plain"},"key":"external_id_{1-3]","value":"int"},{"description":{"content":"Show / hide orders that have been cancelled
\n","type":"text/plain"},"key":"cancelled","value":"boolean"}],"variable":[]}},"response":[{"id":"cbda8505-98bc-469a-a6df-15d307eccc5e","name":"Not found - range","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://{{Dialer URL}}:3007/api/orders/?user_id=&campaign_id=&exact_date=&start_date=2023-11-06&end_date=2023-11-07","protocol":"https","host":["{{Dialer URL}}"],"port":"3007","path":["api","orders",""],"query":[{"key":"user_id","value":""},{"key":"campaign_id","value":""},{"key":"exact_date","value":""},{"key":"start_date","value":"2023-11-06"},{"key":"end_date","value":"2023-11-07"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"2"},{"key":"etag","value":"W/\"2-l9Fw4VUO7kr8CvBlt4zaMCqXZ0w\""},{"key":"date","value":"Sun, 05 Nov 2023 16:52:46 GMT"}],"cookie":[],"responseTime":null,"body":"[]"},{"id":"03a0660a-40e9-4617-9552-9019ef819077","name":"Searching without query values","originalRequest":{"method":"GET","header":[],"url":{"raw":"{your_dialer}.hitrate.tech:3007/api/orders/","host":["{your_dialer}.hitrate.tech"],"port":"3007","path":["api","orders",""],"query":[{"key":"user_id","value":"int","description":"Match on user who created the order","disabled":true},{"key":"campaign_id","value":"int","description":"Match on the campaign where the order was created","disabled":true},{"key":"exact_date","value":"date","description":"Exact date order was palced","disabled":true},{"key":"start_date","value":"date","description":"Start date for creation of order","disabled":true},{"key":"end_date","value":"date","description":"End date for creation of ordder","disabled":true},{"key":"confirm_start_date","value":"date","description":"Start date on when confirmation of order was placed, has higher priority than start_date","disabled":true},{"key":"confirm_end_date","value":"date","description":"End date on when confirmation of order was placed, has higher priority than end_date","disabled":true},{"key":"id","value":"int","description":"Match on exact order id","disabled":true},{"key":"phone","value":"str","description":"Match on orders with specific phone numbers","disabled":true},{"key":"external_id_{1-3]","value":"int","description":"Match on customers with specific external id","disabled":true},{"key":"cancelled","value":"boolean","description":"Show / hide orders that have been cancelled","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"122613"},{"key":"etag","value":"W/\"1def5-49/lX6vDdckGP0ouCv3f/0vAMzA\""},{"key":"date","value":"Fri, 04 Jul 2025 14:16:22 GMT"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": int,\n \"campaign_customer_id\": int,\n \"customer_id\": int,\n \"customer_firstname\": \"str\",\n \"customer_lastname\": \"str\",\n \"customer_address\": \"str\",\n \"customer_postal_code\": \"str\",\n \"customer_city\": \"str\",\n \"customer_phone\": \"str\",\n \"customer_email\": \"str\",\n \"customer_identity_number\": \"str\", // E164 format\n \"is_company\": boolean,\n \"company_name\": \"str\",\n \"company_org_number\": \"str\",\n \"agent_name\": \"str\",\n \"agent_office\": \"str\",\n \"confirmation_datetime\": datetime,\n \"verified\": boolean,\n \"user_id\": int,\n \"create_time\": datetime,\n \"call_id\": int,\n \"order_recording_id\": int,\n \"value\": float,\n \"units\": int,\n \"payment_start_date\": datetime,\n \"validated\": boolean,\n \"api_exporter_status\": int,\n \"api_exporter_sent_date\": datetime,\n \"campaign_id\": int,\n \"campaign_title\": \"str\",\n \"cancelled\": boolean,\n \"order_products\": [\n {\n \"product_id\": int,\n \"units\": int,\n \"unit_price\": float,\n \"title\": \"str\",\n \"artnr\": \"str\",\n \"vat_percentage\": int\n }\n ],\n \"scrive_documents\": [\n {\n \"order_product_id\": int,\n \"status\": \"str\",\n \"last_change\": \"datetime\",\n \"sign_time\": \"datetime\"\n }],\n \"customer_custom_fields\": [\n {\n \"custom_field_30\": \"str\"\n }\n ],\n \"comments\": [\n {\n \"user_id\": int,\n \"comment\": \"str\"\n }\n ]\n }\n]"},{"id":"03cfe938-a45e-48f0-826e-d00891b8fb6c","name":"Searching on user","originalRequest":{"method":"GET","header":[],"url":{"raw":"{your_dialer}.hitrate.tech:3007/api/orders/?user_id=94&start_date=2025-07-03","host":["{your_dialer}.hitrate.tech"],"port":"3007","path":["api","orders",""],"query":[{"key":"user_id","value":"94","description":"Match on user who created the order"},{"key":"campaign_id","value":"int","description":"Match on the campaign where the order was created","disabled":true},{"key":"exact_date","value":"date","description":"Exact date order was palced","disabled":true},{"key":"start_date","value":"2025-07-03","description":"Start date for creation of order"},{"key":"end_date","value":"date","description":"End date for creation of ordder","disabled":true},{"key":"confirm_start_date","value":"date","description":"Start date on when confirmation of order was placed, has higher priority than start_date","disabled":true},{"key":"confirm_end_date","value":"date","description":"End date on when confirmation of order was placed, has higher priority than end_date","disabled":true},{"key":"id","value":"int","description":"Match on exact order id","disabled":true},{"key":"phone","value":"str","description":"Match on orders with specific phone numbers","disabled":true},{"key":"external_id_{1-3]","value":"int","description":"Match on customers with specific external id","disabled":true},{"key":"cancelled","value":"boolean","description":"Show / hide orders that have been cancelled","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"4849"},{"key":"etag","value":"W/\"12f1-YUnzDDr66Vkd51iekGEZo2yRNLk\""},{"key":"date","value":"Fri, 04 Jul 2025 14:22:34 GMT"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": int,\n \"campaign_customer_id\": int,\n \"customer_id\": int,\n \"customer_firstname\": \"str\",\n \"customer_lastname\": \"str\",\n \"customer_address\": \"str\",\n \"customer_postal_code\": \"str\",\n \"customer_city\": \"str\",\n \"customer_phone\": \"str\",\n \"customer_email\": \"str\",\n \"customer_identity_number\": \"str\", // E164 format\n \"is_company\": boolean,\n \"company_name\": \"str\",\n \"company_org_number\": \"str\",\n \"agent_name\": \"str\",\n \"agent_office\": \"str\",\n \"confirmation_datetime\": datetime,\n \"verified\": boolean,\n \"user_id\": int,\n \"create_time\": datetime,\n \"call_id\": int,\n \"order_recording_id\": int,\n \"value\": float,\n \"units\": int,\n \"payment_start_date\": datetime,\n \"validated\": boolean,\n \"api_exporter_status\": int,\n \"api_exporter_sent_date\": datetime,\n \"campaign_id\": int,\n \"campaign_title\": \"str\",\n \"cancelled\": boolean,\n \"order_products\": [\n {\n \"product_id\": int,\n \"units\": int,\n \"unit_price\": float,\n \"title\": \"str\",\n \"artnr\": \"str\",\n \"vat_percentage\": int\n }\n ],\n \"scrive_documents\": [\n {\n \"order_product_id\": int,\n \"status\": \"str\",\n \"last_change\": \"datetime\",\n \"sign_time\": \"datetime\"\n }],\n \"customer_custom_fields\": [\n {\n \"custom_field_30\": \"str\"\n }\n ],\n \"comments\": [\n {\n \"user_id\": int,\n \"comment\": \"str\"\n }\n ]\n }\n]"},{"id":"4200f984-179f-4500-a7a8-5a94114333e5","name":"Searching on phone number","originalRequest":{"method":"GET","header":[],"url":{"raw":"{your_dialer}.hitrate.tech:3007/api/orders/?phone=+4676xxxxxxx","host":["{your_dialer}.hitrate.tech"],"port":"3007","path":["api","orders",""],"query":[{"key":"user_id","value":"","description":"Match on user who created the order","disabled":true},{"key":"campaign_id","value":"int","description":"Match on the campaign where the order was created","disabled":true},{"key":"exact_date","value":"date","description":"Exact date order was palced","disabled":true},{"key":"start_date","value":"","description":"Start date for creation of order","disabled":true},{"key":"end_date","value":"date","description":"End date for creation of ordder","disabled":true},{"key":"confirm_start_date","value":"date","description":"Start date on when confirmation of order was placed, has higher priority than start_date","disabled":true},{"key":"confirm_end_date","value":"date","description":"End date on when confirmation of order was placed, has higher priority than end_date","disabled":true},{"key":"id","value":"int","description":"Match on exact order id","disabled":true},{"key":"phone","value":"+4676xxxxxxx","description":"Match on orders with specific phone numbers, all formats are supported. Results in E164 format"},{"key":"external_id_{1-3]","value":"int","description":"Match on customers with specific external id","disabled":true},{"key":"cancelled","value":"boolean","description":"Show / hide orders that have been cancelled","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"956"},{"key":"etag","value":"W/\"3bc-y7lnBZFh0/PJCpBihZsm+X9HVXI\""},{"key":"date","value":"Fri, 04 Jul 2025 14:24:38 GMT"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": int,\n \"campaign_customer_id\": int,\n \"customer_id\": int,\n \"customer_firstname\": \"str\",\n \"customer_lastname\": \"str\",\n \"customer_address\": \"str\",\n \"customer_postal_code\": \"str\",\n \"customer_city\": \"str\",\n \"customer_phone\": \"str\",\n \"customer_email\": \"str\",\n \"customer_identity_number\": \"str\", // E164 format\n \"is_company\": boolean,\n \"company_name\": \"str\",\n \"company_org_number\": \"str\",\n \"agent_name\": \"str\",\n \"agent_office\": \"str\",\n \"confirmation_datetime\": datetime,\n \"verified\": boolean,\n \"user_id\": int,\n \"create_time\": datetime,\n \"call_id\": int,\n \"order_recording_id\": int,\n \"value\": float,\n \"units\": int,\n \"payment_start_date\": datetime,\n \"validated\": boolean,\n \"api_exporter_status\": int,\n \"api_exporter_sent_date\": datetime,\n \"campaign_id\": int,\n \"campaign_title\": \"str\",\n \"cancelled\": boolean,\n \"order_products\": [\n {\n \"product_id\": int,\n \"units\": int,\n \"unit_price\": float,\n \"title\": \"str\",\n \"artnr\": \"str\",\n \"vat_percentage\": int\n }\n ],\n \"scrive_documents\": [\n {\n \"order_product_id\": int,\n \"status\": \"str\",\n \"last_change\": \"datetime\",\n \"sign_time\": \"datetime\"\n }],\n \"customer_custom_fields\": [\n {\n \"custom_field_30\": \"str\"\n }\n ],\n \"comments\": [\n {\n \"user_id\": int,\n \"comment\": \"str\"\n }\n ]\n }\n]"}],"_postman_id":"2c8b989f-ea11-4d9b-abe1-a35062bfa989"},{"name":"Get order info","id":"4a05070c-4575-4e6f-89ea-7b3b52ecad0a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{API token}"}]},"isInherited":false},"method":"GET","header":[],"url":"{your_dialer}.hitrate.tech:3007/api/order/:id","description":"Get order info on a specific order.
\nFor which data is included in the response body, please refer to the example responses. Custom field and product field data depends on campaign settings.
\n","urlObject":{"port":"3007","path":["api","order",":id"],"host":["{your_dialer}.hitrate.tech"],"query":[],"variable":[{"id":"79155f91-9316-45b0-b3e2-b8502076b317","description":{"content":"Grab full info on specific order
\n","type":"text/plain"},"type":"any","value":"Order id","key":"id"}]}},"response":[{"id":"c365900d-499f-4cc3-85f2-aa2e184ef722","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"{your_dialer}.hitrate.tech:3007/api/order/:id","host":["{your_dialer}.hitrate.tech"],"port":"3007","path":["api","order",":id"],"variable":[{"key":"id","value":"2","description":"Grab full info on specific order"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"954"},{"key":"etag","value":"W/\"3ba-gGKxgYKPGKOa6G+ysTWs7V1DL1A\""},{"key":"date","value":"Fri, 04 Jul 2025 14:26:03 GMT"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": int,\n \"campaign_customer_id\": int,\n \"customer_id\": int,\n \"customer_firstname\": \"str\",\n \"customer_lastname\": \"str\",\n \"customer_address\": \"str\",\n \"customer_postal_code\": \"str\",\n \"customer_city\": \"str\",\n \"customer_phone\": \"str\",\n \"customer_email\": \"str\",\n \"customer_identity_number\": \"str\", // E164 format\n \"is_company\": boolean,\n \"company_name\": \"str\",\n \"company_org_number\": \"str\",\n \"agent_name\": \"str\",\n \"agent_office\": \"str\",\n \"confirmation_datetime\": datetime,\n \"verified\": boolean,\n \"user_id\": int,\n \"create_time\": datetime,\n \"call_id\": int,\n \"order_recording_id\": int,\n \"value\": float,\n \"units\": int,\n \"payment_start_date\": datetime,\n \"validated\": boolean,\n \"api_exporter_status\": int,\n \"api_exporter_sent_date\": datetime,\n \"campaign_id\": int,\n \"campaign_title\": \"str\",\n \"cancelled\": boolean,\n \"order_products\": [\n {\n \"product_id\": int,\n \"units\": int,\n \"unit_price\": float,\n \"title\": \"str\",\n \"artnr\": \"str\",\n \"vat_percentage\": int\n }\n ],\n \"scrive_documents\": [\n {\n \"order_product_id\": int,\n \"status\": \"str\",\n \"last_change\": \"datetime\",\n \"sign_time\": \"datetime\"\n }],\n \"customer_custom_fields\": [\n {\n \"custom_field_30\": \"str\"\n }\n ],\n \"comments\": [\n {\n \"user_id\": int,\n \"comment\": \"str\"\n }\n ]\n }\n]"},{"id":"01f67312-06d6-41a6-b9c1-c466bf9cdbdd","name":"Order not found","originalRequest":{"method":"GET","header":[],"url":{"raw":"{your_dialer}.hitrate.tech:3007/api/order/:id","host":["{your_dialer}.hitrate.tech"],"port":"3007","path":["api","order",":id"],"variable":[{"key":"id","value":"3","description":"Grab full info on specific order"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"29"},{"key":"etag","value":"W/\"1d-fZXiF03Bm+R1qrG0y4tL2TyWwOk\""},{"key":"date","value":"Fri, 04 Jul 2025 14:26:45 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Order not found\"\n}"}],"_postman_id":"4a05070c-4575-4e6f-89ea-7b3b52ecad0a"},{"name":"Get order recording","id":"e24bd91c-c0a7-4301-80a4-880537eaee98","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{API token}"}]},"isInherited":false},"method":"GET","header":[],"url":"{your_dialer}.hitrate.tech:3007/api/order_recording/:order_id","description":"Get order info on a specific order.
\nFor which data is included in the response body, please refer to the example responses. Custom field and product field data depends on campaign settings.
\n","urlObject":{"port":"3007","path":["api","order_recording",":order_id"],"host":["{your_dialer}.hitrate.tech"],"query":[],"variable":[{"description":{"content":"Id for the order whose recording you want to fetch
\n","type":"text/plain"},"type":"any","value":"id","key":"order_id"}]}},"response":[{"id":"b2b3d9c3-abd9-4aca-a778-4056e3d398a5","name":"Get order info Copy","originalRequest":{"method":"GET","header":[],"url":{"raw":"{your_dialer}.hitrate.tech:3007/api/order_recording/:order_id","host":["{your_dialer}.hitrate.tech"],"port":"3007","path":["api","order_recording",":order_id"],"variable":[{"key":"order_id","value":"124","description":"Id for the order whose recording you want to fetch"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"56"},{"key":"etag","value":"W/\"38-aAsL3AGD3w0AmVwi6h8V5DrY/lw\""},{"key":"date","value":"Fri, 21 Nov 2025 10:33:57 GMT"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"message\": \"Order recording not found or not completed\"\n}"}],"_postman_id":"e24bd91c-c0a7-4301-80a4-880537eaee98"},{"name":"Confirm order","id":"cfb76be2-1f94-4710-bed8-687c3a9b7f58","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{your_dialer}.hitrate.tech:3007/api/order/confirm/:id","description":"Orders can be confirmed in four ways:
\nResponding to SMS with confirmation
\nSigning a digital document (Enforced if there's a document on at least one product)
\nCleared by QA based on dialer settings (Enforced if the campaign has QA mode enabled)
\nAutomatically based on campaign settings
\nManually by agents based on permissions
\nBy making an API call
\nIf any of the ones above happens the order counts as confirmed. Digital documents & QA mode are a second and/or third layer of confirmation, the status of the order is reflected based on if the campaign has QA or digital signatures as a requirement.
\nAPI confirming an order counts the same as SMS/automatic/manual confirmation. The type of confirmation can be found on the order, multiple confirmations may exist but only one is needed.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{API token}"}]},"isInherited":true,"source":{"_postman_id":"023d17ad-66f9-41ca-b576-cc71fb619feb","id":"023d17ad-66f9-41ca-b576-cc71fb619feb","name":"HitrateAPI 1.4.4","type":"collection"}},"urlObject":{"port":"3007","path":["api","order","confirm",":id"],"host":["{your_dialer}.hitrate.tech"],"query":[],"variable":[{"id":"5efe9b04-b003-43bd-8afe-c97e39e404f8","description":{"content":"Which order to API confirm
\n","type":"text/plain"},"type":"any","value":"Order id","key":"id"}]}},"response":[{"id":"ab07de1e-9d65-4e00-b206-66606f5382bf","name":"Success","originalRequest":{"method":"POST","header":[],"url":"https://{{Dialer URL}}:3007/api/order/confirm/38"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"27"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Fri, 08 Mar 2024 10:06:40 GMT"},{"key":"Etag","value":"W/\"1b-mfsuEajtPEsQILN5gCNdf+ybsYc\""},{"key":"X-Powered-By","value":"Express"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"id\": 5\n}"},{"id":"00316e78-cd31-4462-8ed7-f729f4c59f7b","name":"Order not found","originalRequest":{"method":"POST","header":[],"url":{"raw":"{your_dialer}.hitrate.tech:3007/api/order/confirm/:id","host":["{your_dialer}.hitrate.tech"],"port":"3007","path":["api","order","confirm",":id"],"variable":[{"key":"id","value":"5","description":"Which order to API confirm"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"81"},{"key":"etag","value":"W/\"51-TRiTHoyacgNtpSH9mgNjQctDJpw\""},{"key":"date","value":"Fri, 04 Jul 2025 14:27:59 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": \"Server Error\",\n \"message\": \"No Order with given id found\"\n}"}],"_postman_id":"cfb76be2-1f94-4710-bed8-687c3a9b7f58"},{"name":"Update product value","id":"d1301583-4abb-4108-b376-b9ec2cc1b66b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"units\": int,\r\n \"unit_price\": float\r\n}","options":{"raw":{"language":"json"}}},"url":"{your_dialer}.hitrate.tech:3007/api/orders/update?order_id=&product_id=","description":"Updates the value a product has on an order.
\nIf product_id is required if the order has more than one product, if only one product exists it will be selected automatically.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{API token}"}]},"isInherited":true,"source":{"_postman_id":"023d17ad-66f9-41ca-b576-cc71fb619feb","id":"023d17ad-66f9-41ca-b576-cc71fb619feb","name":"HitrateAPI 1.4.4","type":"collection"}},"urlObject":{"port":"3007","path":["api","orders","update"],"host":["{your_dialer}.hitrate.tech"],"query":[{"description":{"content":"Which order id to update
\n","type":"text/plain"},"key":"order_id","value":""},{"description":{"content":"Optional if order only has one product, which product to update value
\n","type":"text/plain"},"key":"product_id","value":""}],"variable":[]}},"response":[{"id":"aa1bee86-4726-4ba8-8967-d97f1fe5aec6","name":"Update order based on order_id","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"units\": 1,\r\n \"unit_price\": 1000\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{{Dialer URL}}:3007/api/orders/update?order_id=39","protocol":"https","host":["{{Dialer URL}}"],"port":"3007","path":["api","orders","update"],"query":[{"key":"order_id","value":"39"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"60"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Wed, 20 Mar 2024 14:09:33 GMT"},{"key":"Etag","value":"W/\"3c-W47hyG0WTdbB4lM5ZZKjeObGbJw\""},{"key":"X-Powered-By","value":"Express"}],"cookie":[],"responseTime":null,"body":"{\n \"units\": 1,\n \"unit_price\": 1000,\n \"product_id\": 1,\n \"order_id\": \"39\"\n}"},{"id":"bbce72b1-9a12-45f9-85e4-b10e759c13ef","name":"Not found","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"units\": 1,\r\n \"unit_price\": 100\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{your_dialer}.hitrate.tech:3007/api/orders/update?order_id=5&product_id=","host":["{your_dialer}.hitrate.tech"],"port":"3007","path":["api","orders","update"],"query":[{"key":"order_id","value":"5","description":"Which order id to update"},{"key":"product_id","value":"","description":"Optional if order only has one product, which product to update value"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"37"},{"key":"etag","value":"W/\"25-eYhpPMgM7vM5V7URGZp3L1LV1bs\""},{"key":"date","value":"Fri, 04 Jul 2025 14:29:27 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Order product not found\"\n}"}],"_postman_id":"d1301583-4abb-4108-b376-b9ec2cc1b66b"},{"name":"Cancel orders","id":"2e14e010-4cd7-49b1-a5e2-1606448efd5b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"order_ids\": [int]\r\n}","options":{"raw":{"language":"json"}}},"url":"{your_dialer}.hitrate.tech:3007/api/orders/cancel","description":"Cancels all the orders included in the body.
\nThe orders will remain in the system and be visible to agents/coaches/admins, but filtering (api & exports) and commissions are affected by an order being cancelled.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{API token}"}]},"isInherited":true,"source":{"_postman_id":"023d17ad-66f9-41ca-b576-cc71fb619feb","id":"023d17ad-66f9-41ca-b576-cc71fb619feb","name":"HitrateAPI 1.4.4","type":"collection"}},"urlObject":{"port":"3007","path":["api","orders","cancel"],"host":["{your_dialer}.hitrate.tech"],"query":[],"variable":[]}},"response":[{"id":"85dc9a54-7a4e-41ad-81b0-a78ca6fb0213","name":"Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"order_ids\": [278]\r\n}","options":{"raw":{"language":"json"}}},"url":"{your_dialer}.hitrate.tech:3007/api/orders/cancel"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"54"},{"key":"etag","value":"W/\"36-ltEA9ltYAuVZbTwnb9dN6Dp9QBk\""},{"key":"date","value":"Fri, 04 Jul 2025 14:12:00 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"succeeded_ids\": [\n 278\n ],\n \"failed_ids\": []\n}"},{"id":"bfb094ed-b484-4ca3-920b-f256d9e8f884","name":"Order is already cancelled","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"order_ids\": [202]\r\n}","options":{"raw":{"language":"json"}}},"url":"{your_dialer}.hitrate.tech:3007/api/orders/cancel"},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"80"},{"key":"etag","value":"W/\"50-aWzymgX9fNCQH0U1FoyLp2RAVFM\""},{"key":"date","value":"Fri, 04 Jul 2025 14:11:07 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"failed_ids\": [\n {\n \"id\": 202,\n \"error\": \"Order is already cancelled\"\n }\n ]\n}"}],"_postman_id":"2e14e010-4cd7-49b1-a5e2-1606448efd5b"},{"name":"Update order status","id":"6e0a67dc-c783-4a3b-b72f-c295e1b58e15","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"status\": \"str\",\r\n \"cancelled\": boolean,\r\n \"verified\": boolean,\r\n \"comment\": \"str\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{your_dialer}.hitrate.tech:3007/api/order/status/:id","description":"This endpoint is to help sync order validation/cancellation with external systems by having most common actions in one endpoints. Actions are as such:
\nstatus: send in a custom status to track the order progress. This is shown to agents
\ncomment: add a comment for admin/coach/IT to track the order, not visible for agents
\nverified: set the order as confirmed. Same effect as digital signature/sms ok/marked by coach/other API calls
\ncancelled: set the order as cancelled. Affects comission and exporting of order in system/API
\nAll parameters are optional, if they are left out the order will keep their old value. As such you don't need to keep track of what the values are if you don't want to.
Sending in any value will replace the old value, for example having a cancelled order and then sending in cancelled: false will remove the cancellation.
Which order to API confirm
\n","type":"text/plain"},"type":"any","value":"Order id","key":"id"}]}},"response":[{"id":"79ee252d-dbd2-4713-9563-64856bf5e740","name":"Success","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"status\": \"Success\",\r\n \"cancelled\": false,\r\n \"verified\": true,\r\n \"comment\": \"Test call\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{your_dialer}.hitrate.tech:3007/api/order/status/:id","host":["{your_dialer}.hitrate.tech"],"port":"3007","path":["api","order","status",":id"],"variable":[{"key":"id","value":"2","description":"Which order to API confirm"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"16"},{"key":"etag","value":"W/\"10-oV4hJxRVSENxc/wX8+mA4/Pe4tA\""},{"key":"date","value":"Fri, 04 Jul 2025 14:30:38 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true\n}"},{"id":"c6b54527-bcef-438c-bf88-76ded4322534","name":"Order not found","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"status\": \"Success\",\r\n \"cancelled\": false,\r\n \"verified\": true,\r\n \"comment\": \"Test call\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{your_dialer}.hitrate.tech:3007/api/order/status/:id","host":["{your_dialer}.hitrate.tech"],"port":"3007","path":["api","order","status",":id"],"variable":[{"key":"id","value":"3","description":"Which order to API confirm"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"60"},{"key":"etag","value":"W/\"3c-tebX1Hr+Gb5QU0cJ3RGB6mQqABo\""},{"key":"date","value":"Fri, 04 Jul 2025 14:30:55 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"message\": \"Order with ID 3 does not exist\"\n}"},{"id":"d5e409f0-abf1-4dc0-9162-d9fa833df90f","name":"Only validate the order","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"verified\": true\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{your_dialer}.hitrate.tech:3007/api/order/status/:id","host":["{your_dialer}.hitrate.tech"],"port":"3007","path":["api","order","status",":id"],"variable":[{"key":"id","value":"2","description":"Which order to API confirm"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"16"},{"key":"etag","value":"W/\"10-oV4hJxRVSENxc/wX8+mA4/Pe4tA\""},{"key":"date","value":"Fri, 04 Jul 2025 14:31:28 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true\n}"},{"id":"09118cda-41c9-4761-b6e5-429b9e46e2fe","name":"Only update status","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"status\": \"Success\",\r\n \"comment\": \"Looks good\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{your_dialer}.hitrate.tech:3007/api/order/status/:id","host":["{your_dialer}.hitrate.tech"],"port":"3007","path":["api","order","status",":id"],"variable":[{"key":"id","value":"2","description":"Which order to API confirm"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"16"},{"key":"etag","value":"W/\"10-oV4hJxRVSENxc/wX8+mA4/Pe4tA\""},{"key":"date","value":"Fri, 04 Jul 2025 14:31:50 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true\n}"},{"id":"a5b12e13-3ae0-47cf-ab96-16e07e94dd9b","name":"Only mark as cancelled","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"cancelled\": true\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{your_dialer}.hitrate.tech:3007/api/order/status/:id","host":["{your_dialer}.hitrate.tech"],"port":"3007","path":["api","order","status",":id"],"variable":[{"key":"id","value":"2","description":"Which order to API confirm"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"16"},{"key":"etag","value":"W/\"10-oV4hJxRVSENxc/wX8+mA4/Pe4tA\""},{"key":"date","value":"Fri, 04 Jul 2025 14:32:15 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true\n}"}],"_postman_id":"6e0a67dc-c783-4a3b-b72f-c295e1b58e15"}],"id":"31ceeab1-658b-46cf-88c2-9eefdfae8e71","description":"Orders handle data similarly to contactlists. They contain standard fields for orders but can be populated with custom fields that can be used by agent to enter data during an order.
\nManually confirmed by a coach/admin
\nBy customer responding to an order sms with a valid message, such as \"OK\"
\nBy the agent adding a voice receipt/order recording to the order
\nThrough a digital signature, such as Scrive
\nPassing QA check on a campaign that his this active
\nExternally through an API call
\nAutomatically based on the campaign settings for automatically confirming orders
\nThis depends on the campaign, the orders are marked as confirmed in the API when ALL requirements on the campaign has been met.
\nManually by the agent who placed the order
\nManually by a coach/admin
\nAutomatically by importing a file and matching a row to the customer and order, there are multiple ways to match the order.
\nBy a user through our external API
\nGets a specific product template.
\nThe response is the same as get all templates endpoint but for one specific product.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{API token}"}]},"isInherited":true,"source":{"_postman_id":"023d17ad-66f9-41ca-b576-cc71fb619feb","id":"023d17ad-66f9-41ca-b576-cc71fb619feb","name":"HitrateAPI 1.4.4","type":"collection"}},"urlObject":{"port":"3007","path":["api","product",":id"],"host":["{your_dialer}.hitrate.tech"],"query":[],"variable":[{"id":"12d7c171-c26d-4d68-9580-182af95851f1","description":{"content":"What product id to get
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"8bcb188e-c52a-415e-9521-dc21f103e589","name":"Success","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{{Dialer URL}}:3007/api/product/:id","protocol":"https","host":["{{Dialer URL}}"],"port":"3007","path":["api","product",":id"],"variable":[{"key":"id","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"480"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Tue, 11 Jun 2024 08:14:33 GMT"},{"key":"Etag","value":"W/\"1e0-ouhdqK2C1rX6bwS/0/uQAWenjgs\""},{"key":"X-Powered-By","value":"Express"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 1,\n \"office_id\": 2,\n \"client_id\": null,\n \"artnr\": \"10001\",\n \"title\": \"Example product\",\n \"product_type_id\": 0,\n \"periodicity_id\": 0,\n \"periodicity_parts\": 0,\n \"price\": 1250,\n \"adjusted_price\": null,\n \"flex_price\": 0,\n \"vat_percentage\": 25,\n \"min_price\": null,\n \"max_price\": null,\n \"description\": null,\n \"script\": null,\n \"active\": 1,\n \"notification_sms_enabled\": 0,\n \"notify_before_confirm\": 0,\n \"notification_sms_template\": null,\n \"notification_sms_sender\": null,\n \"notification_sms_max_age\": null,\n \"selectable_delivery_method\": 0,\n \"sms_text\": null,\n \"deleted\": 0\n}"},{"id":"84387807-c1a0-4530-81e6-628cf8a46c55","name":"Product not found","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"{your_dialer}.hitrate.tech:3007/api/product/:id","host":["{your_dialer}.hitrate.tech"],"port":"3007","path":["api","product",":id"],"variable":[{"key":"id","value":"10"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"html","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"text/html; charset=utf-8"},{"key":"content-length","value":"34"},{"key":"etag","value":"W/\"22-SzcCbnw2DUKpsvLbuWl+IASFxSw\""},{"key":"date","value":"Mon, 11 Nov 2024 08:36:58 GMT"}],"cookie":[],"responseTime":null,"body":"Product not found or access denied"}],"_postman_id":"85984c7b-fcbd-43c9-99dc-20c8ab425a74"},{"name":"Get all product templates","id":"66a3a6e1-0c01-4c89-bd68-cd709145f99a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{your_dialer}.hitrate.tech:3007/api/product","description":"Lists all products in the dialer. Active decides wheter or not the product can be used. Deleted products aren't accessible from the UI.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{API token}"}]},"isInherited":true,"source":{"_postman_id":"023d17ad-66f9-41ca-b576-cc71fb619feb","id":"023d17ad-66f9-41ca-b576-cc71fb619feb","name":"HitrateAPI 1.4.4","type":"collection"}},"urlObject":{"port":"3007","path":["api","product"],"host":["{your_dialer}.hitrate.tech"],"query":[],"variable":[]}},"response":[{"id":"bc7c1947-f20c-498f-b885-ac914e8e88f4","name":"Success","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{{Dialer URL}}:3007/api/product/:id","protocol":"https","host":["{{Dialer URL}}"],"port":"3007","path":["api","product",":id"],"variable":[{"key":"id","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"480"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Tue, 11 Jun 2024 08:14:33 GMT"},{"key":"Etag","value":"W/\"1e0-ouhdqK2C1rX6bwS/0/uQAWenjgs\""},{"key":"X-Powered-By","value":"Express"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 1,\n \"client_id\": null,\n \"artnr\": \"10001\",\n \"title\": \"Example product\",\n \"sms_text\": \"Text in sms\",\n \"product_type_id\": 0,\n \"periodicity_id\": 0,\n \"periodicity_parts\": 0,\n \"price\": 1250,\n \"adjusted_price\": null,\n \"flex_price\": 0,\n \"vat_percentage\": 25,\n \"min_price\": null,\n \"max_price\": null,\n \"description\": null,\n \"script\": null,\n \"active\": 1,\n \"notification_sms_enabled\": 0,\n \"notify_before_confirm\": 0,\n \"notification_sms_template\": null,\n \"notification_sms_sender\": null,\n \"notification_sms_max_age\": null,\n \"selectable_delivery_method\": 0,\n \"sms_text\": null,\n \"deleted\": 0\n}"}],"_postman_id":"66a3a6e1-0c01-4c89-bd68-cd709145f99a"},{"name":"Create product template","id":"ecd9b530-e7ac-46ce-9711-fef42b538610","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"artnr\": \"str\",\r\n \"title\": \"str\", //required\r\n \"sms_text\": \"str\",\r\n \"description\": \"str\",\r\n \"product_type_id\": int,\r\n \"periodicity_id\": int,\r\n \"periodicty_parts\": int,\r\n \"price\": float, //required, default is 0\r\n \"vat_percentage\": float,\r\n \"min_price\": float,\r\n \"max_price\": float,\r\n \"notification_sms\": boolean,\r\n \"notification_sms_template\": int,\r\n \"notification_sms_sender\": \"str\",\r\n \"notificaiton_sms_max_age\": int,\r\n \"product_fields\": [\r\n {\r\n \"product_field_id\": int,\r\n \"validator\": int,\r\n \"required\": boolean\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{your_dialer}.hitrate.tech:3007/api/product","description":"Creates a new product.
\nAll values except title and price is mandatory.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{API token}"}]},"isInherited":true,"source":{"_postman_id":"023d17ad-66f9-41ca-b576-cc71fb619feb","id":"023d17ad-66f9-41ca-b576-cc71fb619feb","name":"HitrateAPI 1.4.4","type":"collection"}},"urlObject":{"protocol":"https","port":"3007","path":["api","product"],"host":["{your_dialer}.hitrate.tech"],"query":[],"variable":[]}},"response":[{"id":"a6b33008-5344-4e35-b158-782a86fda1ba","name":"Simple product creation","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"artnr\": \"Internal number\",\r\n \"title\": \"Gold product\",\r\n \"sms_text\": \"Our best product, priced at !order_value\",\r\n \"description\": \"Best product we offer\",\r\n \"price\": 250.00\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{Dialer URL}}:3007/api/product"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"28"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Fri, 05 Jul 2024 09:36:05 GMT"},{"key":"Etag","value":"W/\"1c-JVl2Sy9aHzoUiDYqfPNBfFoQ1mo\""},{"key":"X-Powered-By","value":"Express"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"id\": 26\n}"},{"id":"04a2cf57-b1c2-401f-8356-7ca5f7e5a986","name":"Missing title field","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"description\": \"We forgot few fields\",\r\n \"product_type_id\": 1,\r\n \"periodicity_id\": 1\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{Dialer URL}}:3007/api/product"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"105"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Fri, 05 Jul 2024 09:36:42 GMT"},{"key":"Etag","value":"W/\"69-e/D6R+gKu4OpxFRB+N9a+uWSYjY\""},{"key":"X-Powered-By","value":"Express"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Error\",\n \"code\": 1,\n \"str\": \"Validation error\",\n \"replacements\": {},\n \"extra\": [\n [\n \"title\",\n \"is required!\"\n ]\n ]\n}"},{"id":"38bcf862-6a20-4af5-b647-d54682528baa","name":"Create product template","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"artnr\": \"AE31543\",\r\n \"title\": \"Car order\",\r\n \"description\": \"A more complicated product\",\r\n \"product_type_id\": 1,\r\n \"price\": 450.00,\r\n \"vat_percentage\": 25.00,\r\n \"notification_sms_template\": 1,\r\n \"notification_sms_sender\": \"Hitrate\",\r\n \"notificaiton_sms_max_age\": 24,\r\n \"product_fields\": [{\r\n \"product_field_id\": 8,\r\n \"validator\": 1,\r\n \"required\": 1\r\n },\r\n {\r\n \"product_field_id\": 9,\r\n \"required\": 1\r\n },\r\n {\r\n \"product_field_id\": 13,\r\n \"validator\" 7,\r\n \"required\": 1\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{Dialer URL}}:3007/api/product"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"28"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Fri, 05 Jul 2024 09:37:16 GMT"},{"key":"Etag","value":"W/\"1c-YpMHn2zEL3Crhqqauio7U6x3XTA\""},{"key":"X-Powered-By","value":"Express"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"id\": 109\n}"}],"_postman_id":"ecd9b530-e7ac-46ce-9711-fef42b538610"},{"name":"Update product template","id":"c9acbce9-64f7-4794-8db2-12462a93ee64","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"artnr\": \"str\",\r\n \"office_id\" int,\r\n \"title\": \"str\",\r\n \"sms_text\": \"str\",\r\n \"description\": \"str\",\r\n \"product_type_id\": int,\r\n \"periodicity_id\": int,\r\n \"periodicty_parts\": int,\r\n \"price\": float,\r\n \"vat_percentage\": float,\r\n \"min_price\": float, \r\n \"max_price\": float,\r\n \"notification_sms_template\": int,\r\n \"notification_sms_sender\": \"str\",\r\n \"notificaiton_sms_max_age\": int,\r\n \"product_fields\": [{\r\n \"product_field_id\": int,\r\n \"validator\": int,\r\n \"required\": boolean,\r\n \"delete\": boolean\r\n }]\r\n}","options":{"raw":{"language":"json"}}},"url":"{your_dialer}.hitrate.tech:3007/api/product","description":"List the product field/s you want to update inside product_fields array with any new data to be added. If deleted is sent in with a \"1\" the product field is deleted. Any orders that has had this field stores it's data in database and for exports, but is not visible/editble in UI.
\nSend in any data to be replaced on a product template. Any data that is not sent in will keep it's old value.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{API token}"}]},"isInherited":true,"source":{"_postman_id":"023d17ad-66f9-41ca-b576-cc71fb619feb","id":"023d17ad-66f9-41ca-b576-cc71fb619feb","name":"HitrateAPI 1.4.4","type":"collection"}},"urlObject":{"port":"3007","path":["api","product"],"host":["{your_dialer}.hitrate.tech"],"query":[],"variable":[]}},"response":[{"id":"e83a3bb2-75b5-4806-9d09-a1ea29758d54","name":"Product field not found","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"product_fields\": [{\r\n \"product_field_id\": 8,\r\n \"delete\": 1\r\n }]\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{{Dialer URL}}:3007/api/product/:id","protocol":"https","host":["{{Dialer URL}}"],"port":"3007","path":["api","product",":id"],"variable":[{"key":"id","value":"28"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"html","header":[{"key":"Content-Length","value":"40"},{"key":"Content-Type","value":"text/html; charset=utf-8"},{"key":"Date","value":"Fri, 05 Jul 2024 12:42:32 GMT"},{"key":"Etag","value":"W/\"28-HCwb/1wEMsgc7tLZnk2QfUJo5fg\""},{"key":"X-Powered-By","value":"Express"}],"cookie":[],"responseTime":null,"body":"Error updating product or product fields"}],"_postman_id":"c9acbce9-64f7-4794-8db2-12462a93ee64"},{"name":"Remove product template","id":"81105831-9f05-415d-bd58-daf5ee5e5168","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"{your_dialer}.hitrate.tech:3007/api/product/:id","description":"Remove product template form the dailer. Already created orders that uses this product will won't be affected.
\nThis action can be reversed through API or with help of a Hitrate Admin or support.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{API token}"}]},"isInherited":true,"source":{"_postman_id":"023d17ad-66f9-41ca-b576-cc71fb619feb","id":"023d17ad-66f9-41ca-b576-cc71fb619feb","name":"HitrateAPI 1.4.4","type":"collection"}},"urlObject":{"port":"3007","path":["api","product",":id"],"host":["{your_dialer}.hitrate.tech"],"query":[],"variable":[{"id":"3e315c9b-3951-4c35-bf04-98ce42deb79e","description":{"content":"Which product to delete
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"37f07806-755d-460d-83e3-260a149050ad","name":"Success","originalRequest":{"method":"DELETE","header":[],"url":"https://{your_dialer}.hitrate.tech:3007/api/product/3"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"41"},{"key":"etag","value":"W/\"29-JskuRgk76F8fO5y4V+RqE3owcBs\""},{"key":"date","value":"Fri, 30 Aug 2024 12:34:17 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"3\",\n \"message\": \"Product is deleted\"\n}"}],"_postman_id":"81105831-9f05-415d-bd58-daf5ee5e5168"},{"name":"Get product fields","id":"60692f93-d6e0-4817-b3fd-52ef68eea074","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{your_dialer}.hitrate.tech:3007/api/products/field","description":"Lists product fields that can be added to a product template.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{API token}"}]},"isInherited":true,"source":{"_postman_id":"023d17ad-66f9-41ca-b576-cc71fb619feb","id":"023d17ad-66f9-41ca-b576-cc71fb619feb","name":"HitrateAPI 1.4.4","type":"collection"}},"urlObject":{"port":"3007","path":["api","products","field"],"host":["{your_dialer}.hitrate.tech"],"query":[],"variable":[]}},"response":[{"id":"6a1608c4-094e-4bff-8b24-5c472ded75e4","name":"Succesful","originalRequest":{"method":"GET","header":[],"url":"https://{{Dialer URL}}:3007/api/products/field"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"2091"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Tue, 11 Jun 2024 08:22:18 GMT"},{"key":"Etag","value":"W/\"82b-mrV2YKvnxnR0+nS89Hzo1MNdDWY\""},{"key":"X-Powered-By","value":"Express"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 8,\n \"name\": \"Comment\",\n \"datatype\": \"string\",\n \"default_value\": null,\n \"options\": null,\n \"type\": 2,\n \"description\": null,\n \"deleted\": 0\n },\n {\n \"id\": 13,\n \"name\": \"Booked time\",\n \"datatype\": \"datetime\",\n \"default_value\": null,\n \"options\": null,\n \"type\": 2,\n \"description\": null,\n \"deleted\": 0\n },\n {\n \"id\": 14,\n \"name\": \"Booked date\",\n \"datatype\": \"date\",\n \"default_value\": null,\n \"options\": null,\n \"type\": 2,\n \"description\": null,\n \"deleted\": 0\n },\n {\n \"id\": 15,\n \"name\": \"Numeric product field\",\n \"datatype\": \"int\",\n \"default_value\": \"0\",\n \"options\": null,\n \"type\": 2,\n \"description\": null,\n \"deleted\": 0\n },\n {\n \"id\": 16,\n \"name\": \"Long text product field\",\n \"datatype\": \"text\",\n \"default_value\": null,\n \"options\": null,\n \"type\": 2,\n \"description\": \"Like a short text product field, but takes more space on customer card\",\n \"deleted\": 0\n },\n {\n \"id\": 17,\n \"name\": \"Boolean product field\",\n \"datatype\": \"boolean\",\n \"default_value\": null,\n \"options\": null,\n \"type\": 2,\n \"description\": \"Is displayed as a toggle on the customer card\",\n \"deleted\": 0\n },\n {\n \"id\": 18,\n \"name\": \"Dropdown product field\",\n \"datatype\": \"dropdown\",\n \"default_value\": null,\n \"options\": \"Option A;;Value B;;Selection C\",\n \"type\": 2,\n \"description\": \"Only specific allowed values\",\n \"deleted\": 0\n },\n {\n \"id\": 19,\n \"name\": \"Multi value product field\",\n \"datatype\": \"multi\",\n \"default_value\": null,\n \"options\": \"{\\\"cols\\\":[\\\"Product\\\",\\\"Price\\\",\\\"Weight\\\",\\\"Postage\\\"],\\\"values\\\":[[\\\"Phone\\\",\\\"749\\\",\\\"0,3\\\",\\\"3,99\\\"],[\\\"Airpods\\\",\\\"59\\\",\\\"0,1\\\",\\\"1,99\\\"],[\\\"Computer\\\",\\\"1249\\\",\\\"4,8\\\",\\\"12,99\\\"],[\\\"Airfyer\\\",\\\"149\\\",\\\"1,3\\\",\\\"3,99\\\"]],\\\"disabled\\\":{\\\"values\\\":[2],\\\"cols\\\":[2]}}\",\n \"type\": 2,\n \"description\": null,\n \"deleted\": 0\n }\n]"}],"_postman_id":"60692f93-d6e0-4817-b3fd-52ef68eea074"},{"name":"Get specific product field","id":"b3d24803-c5a5-41df-a744-61ed51236b10","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{your_dialer}.hitrate.tech:3007/api/products/field/:id","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{API token}"}]},"isInherited":true,"source":{"_postman_id":"023d17ad-66f9-41ca-b576-cc71fb619feb","id":"023d17ad-66f9-41ca-b576-cc71fb619feb","name":"HitrateAPI 1.4.4","type":"collection"}},"urlObject":{"port":"3007","path":["api","products","field",":id"],"host":["{your_dialer}.hitrate.tech"],"query":[],"variable":[{"id":"ee168c2f-3f71-44e7-96b1-29533a834fac","description":{"content":"Which product field to get information on
\n","type":"text/plain"},"type":"any","value":"product field id","key":"id"}]}},"response":[{"id":"33c9542c-bd2a-4b64-b586-d444452e7494","name":"Product field found","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{{Dialer URL}}:3007/api/products/field/:id","protocol":"https","host":["{{Dialer URL}}"],"port":"3007","path":["api","products","field",":id"],"variable":[{"key":"id","value":"15"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"132"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Tue, 11 Jun 2024 08:23:13 GMT"},{"key":"Etag","value":"W/\"84-b/sB4RQS85Ko91TCdWUtQ8MGCxc\""},{"key":"X-Powered-By","value":"Express"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 15,\n \"name\": \"Numeric product field\",\n \"datatype\": \"int\",\n \"default_value\": \"0\",\n \"options\": null,\n \"type\": 2,\n \"description\": null,\n \"deleted\": 0\n}"},{"id":"440afa10-7e81-447d-b899-57d57c55d803","name":"Not found","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{{Dialer URL}}:3007/api/products/field/:id","protocol":"https","host":["{{Dialer URL}}"],"port":"3007","path":["api","products","field",":id"],"variable":[{"key":"id","value":"73"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"html","header":[{"key":"Content-Length","value":"27"},{"key":"Content-Type","value":"text/html; charset=utf-8"},{"key":"Date","value":"Tue, 11 Jun 2024 08:23:47 GMT"},{"key":"Etag","value":"W/\"1b-VUyD6LsLQHXYXNfY0H7ApGFoIRs\""},{"key":"X-Powered-By","value":"Express"}],"cookie":[],"responseTime":null,"body":"Custom Field does not exist"}],"_postman_id":"b3d24803-c5a5-41df-a744-61ed51236b10"},{"name":"Create new product field","id":"4e3ab540-6c17-4096-8cd2-06221d098a19","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"name\": \"str\",\r\n \"datatype\": \"str\",\r\n \"default_value\": \"str\",\r\n \"options\": [\"str\"],\r\n \"description\": \"str\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{your_dialer}.hitrate.tech:3007/api/products/field","description":"Product fields are limited to what data it can contain based on its datatype. Dropdown and multi datatype also need options filled in to specify what values it can contain.
\nint
\nstring
\ntext
\nboolean
\ndatetime
\ndate
\ndropdown*
\nmulti*
\nDropdown: [\"str\",\"str\",\"str\"]
Seperate all options in the dropdown into seperate strings.
Multi: [\"str;str;str\", \"str;str;str\", \"str;str,str\"]
Each string is a specific column for the multi datatype. The first value in each string is the column names, second value and onwards become the options that users in the dialer can choose.
Update values for a specific product field.
\nIf datatype is changed it may break statistic KPIs if any of the existing values on any customer contain data from an older type.
\nOptions will be omittied if an update is made on a datatype that isn't dropdown or multiple values.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{API token}"}]},"isInherited":true,"source":{"_postman_id":"023d17ad-66f9-41ca-b576-cc71fb619feb","id":"023d17ad-66f9-41ca-b576-cc71fb619feb","name":"HitrateAPI 1.4.4","type":"collection"}},"urlObject":{"port":"3007","path":["api","products","field",":id"],"host":["{your_dialer}.hitrate.tech"],"query":[],"variable":[{"id":"cd66ea1a-fda8-41c0-9e83-874dca700ddf","description":{"content":"Which product field to update
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"5d257f05-1f72-4e60-9935-c974ec4afd91","name":"Success","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"name\": \"New name\",\r\n \"datatype\": \"string\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{your_dialer}.hitrate.tech:3007/api/products/field/1"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"57"},{"key":"etag","value":"W/\"39-3S8IkwFRwu7wJ50KHANnvvPlLUk\""},{"key":"date","value":"Fri, 30 Aug 2024 12:43:34 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"1\",\n \"name\": \"New name\",\n \"datatype\": \"string\",\n \"type\": 2\n}"}],"_postman_id":"3554f357-c787-4616-bc31-b7b459229695"},{"name":"Delete product field","id":"2bfc771c-cb88-4108-a2eb-b0ee5f62dc8a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"{your_dialer}.hitrate.tech:3007/api/products/field/:id","description":"Deletes product field and removes them from any product template that has it.
\nValue for the products already created will not be removed.
\nThis action can be reversed with the help of a Hitrate admin or support.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{API token}"}]},"isInherited":true,"source":{"_postman_id":"023d17ad-66f9-41ca-b576-cc71fb619feb","id":"023d17ad-66f9-41ca-b576-cc71fb619feb","name":"HitrateAPI 1.4.4","type":"collection"}},"urlObject":{"port":"3007","path":["api","products","field",":id"],"host":["{your_dialer}.hitrate.tech"],"query":[],"variable":[{"id":"2dbded09-fc59-45a4-9473-854ebeaa8afc","description":{"content":"Which product field to delete
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"ca6b0d82-60d9-4a9e-95eb-b653fca604d7","name":"Success","originalRequest":{"method":"DELETE","header":[],"url":"https://{your_dialer}.hitrate.tech:3007/api/products/field/1"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"47"},{"key":"etag","value":"W/\"2f-VqQHB5xpKGGqpJ5wHb6d/exV/68\""},{"key":"date","value":"Fri, 30 Aug 2024 12:43:59 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"1\",\n \"message\": \"Product field is deleted\"\n}"}],"_postman_id":"2bfc771c-cb88-4108-a2eb-b0ee5f62dc8a"}],"id":"a78c1084-a865-418b-8ff4-4f2fca795ed1","description":"Products can be added to orders, this determines what items the order contains and what value it should have.
\nA product can have some standard values:
\nIn most cases these fields aren't enough to collect enough information to place an order. Any extra data that needs to be collected can be done so with product fields which are able to be customized.
\nPeriodicity type and parts are optional, this is for integrations to payment providers.
\n","_postman_id":"a78c1084-a865-418b-8ff4-4f2fca795ed1","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{API token}"}]},"isInherited":true,"source":{"_postman_id":"023d17ad-66f9-41ca-b576-cc71fb619feb","id":"023d17ad-66f9-41ca-b576-cc71fb619feb","name":"HitrateAPI 1.4.4","type":"collection"}}},{"name":"SMS","item":[{"name":"Get sms templates","id":"4de536a9-dc86-476c-a102-930daa4da036","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{your_dialer}.hitrate.tech:3007/api/sms_templates","description":"Lists all sms templates.
\nThe response includes their id, content and which office they belong to.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{API token}"}]},"isInherited":true,"source":{"_postman_id":"023d17ad-66f9-41ca-b576-cc71fb619feb","id":"023d17ad-66f9-41ca-b576-cc71fb619feb","name":"HitrateAPI 1.4.4","type":"collection"}},"urlObject":{"port":"3007","path":["api","sms_templates"],"host":["{your_dialer}.hitrate.tech"],"query":[],"variable":[]}},"response":[{"id":"e69014fc-10c6-4f46-9dc0-424000795b87","name":"Get sms templates","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://{{Dialer URL}}:3007/api/sms_templates"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"1193"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Tue, 11 Jun 2024 09:40:03 GMT"},{"key":"Etag","value":"W/\"4a9-ooMqQoSrau6rJYEznidSrujC+es\""},{"key":"X-Powered-By","value":"Express"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 1,\n \"title\": \"SMS testing template\",\n \"content\": \"Hello !firstname\\nI am a SMS template and I am looking for a home.\\nCan you help me by answering ok to test sms valdiation?\\n\\nRegrads,\\nHitrate\"\n },\n {\n \"id\": 2,\n \"title\": \"Answer SMS\",\n \"content\": \"Hi! Thank you for your order.\"\n },\n {\n \"id\": 3,\n \"title\": \"Generic offer sms\",\n \"content\": \"Hi !firstname!\\n\\nWe thank you for your interest in our services and will send you an offer by mail in the coming weeks.\\nShould you have questions or change your mind please don't hesitate to reach out\"\n },\n {\n \"id\": 4,\n \"title\": \"Empty template\",\n \"content\": \"\"\n }\n]"}],"_postman_id":"4de536a9-dc86-476c-a102-930daa4da036"},{"name":"Get specific sms template","id":"fdfa2a84-c7bb-483e-beb2-8316e8a90014","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{your_dialer}.hitrate.tech:3007/api/sms_template/:id","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{API token}"}]},"isInherited":true,"source":{"_postman_id":"023d17ad-66f9-41ca-b576-cc71fb619feb","id":"023d17ad-66f9-41ca-b576-cc71fb619feb","name":"HitrateAPI 1.4.4","type":"collection"}},"urlObject":{"port":"3007","path":["api","sms_template",":id"],"host":["{your_dialer}.hitrate.tech"],"query":[],"variable":[{"id":"26a3a39c-e616-4d2e-9802-f4fb2a65833a","description":{"content":"Sms tempalte to view
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"a83eafd3-47f7-4360-89d0-33687738034a","name":"Get specific sms template","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"{your_dialer}.hitrate.tech:3007/api/sms_template/:id","host":["{your_dialer}.hitrate.tech"],"port":"3007","path":["api","sms_template",":id"],"variable":[{"key":"id","value":"2","description":"Sms tempalte to view"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"148"},{"key":"etag","value":"W/\"94-ucKnxP3jEUevC93cYz9/J7IFdvw\""},{"key":"date","value":"Fri, 04 Jul 2025 13:53:51 GMT"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"id\": 2,\n \"title\": \"Order sms\",\n \"content\": \"Hi !firstname !lastname. Answer with \\\"Ok\\\" to confirm your order.\",\n \"office_id\": null\n}"},{"id":"fbb8c153-08a9-43b1-86f4-2269a3f3c4df","name":"Sms template doesn't exist","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"{your_dialer}.hitrate.tech:3007/api/sms_template/:id","host":["{your_dialer}.hitrate.tech"],"port":"3007","path":["api","sms_template",":id"],"variable":[{"key":"id","value":"3","description":"Sms tempalte to view"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"58"},{"key":"etag","value":"W/\"3a-NosbaPODE+ecmOwY90JSAPdHflc\""},{"key":"date","value":"Fri, 04 Jul 2025 13:54:43 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Access denied or SMS Template does not exist\"\n}"}],"_postman_id":"fdfa2a84-c7bb-483e-beb2-8316e8a90014"},{"name":"List string replacements","id":"4247ed91-32e3-4346-82aa-1751f34a80c5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{your_dialer}.hitrate.tech:3007/api/sms_templates/sms_tokens","description":"Lists all the available string replacements keys that can be used in SMS or email templates
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{API token}"}]},"isInherited":true,"source":{"_postman_id":"023d17ad-66f9-41ca-b576-cc71fb619feb","id":"023d17ad-66f9-41ca-b576-cc71fb619feb","name":"HitrateAPI 1.4.4","type":"collection"}},"urlObject":{"port":"3007","path":["api","sms_templates","sms_tokens"],"host":["{your_dialer}.hitrate.tech"],"query":[],"variable":[]}},"response":[{"id":"ef154a7d-1dc3-4387-8ce5-f9a555a0a18a","name":"Success","originalRequest":{"method":"GET","header":[],"url":"{your_dialer}.hitrate.tech:3007/api/sms_templates/sms_tokens"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"2983"},{"key":"etag","value":"W/\"ba7-H4jxDGfXdGvTzhC7rHeVNAuSDu0\""},{"key":"date","value":"Fri, 04 Jul 2025 13:56:26 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"!firstname\": \"First name of customer\",\n \"!lastname\": \"Last name of customer\",\n \"!middlename\": \"Middle name of customer\",\n \"!company_name\": \"Company name of customer\",\n \"!identity_number\": \"Identity number of customer\",\n \"!orgnumber\": \"Org.nr of customer\",\n \"!address\": \"Address of customer\",\n \"!postal_code\": \"Postal code of customer\",\n \"!city\": \"City of customer\",\n \"!phonenumber\": \"Phone number of customer\",\n \"!email\": \"Email of customer\",\n \"!custom_field_name_[id]\": \"Custom field name of custom field with id [id]\",\n \"!custom_field_[id]\": \"Custom field value of custom field with id [id]\",\n \"!order_id\": \"ID of order\",\n \"!order_value\": \"Total value of all products on the order (no currency denotation included)\",\n \"!order_units\": \"Total number of products on the order\",\n \"!user_firstname\": \"First name of agent that owns order\",\n \"!user_lastname\": \"Last name of agent that owns order\",\n \"!user_email\": \"Email of agent that owns order\",\n \"!any_product_id\": \"ID of an arbitrary product that is part of the order\",\n \"!any_product_artnr\": \"Art.nr of an arbitrary product that is part of the order\",\n \"!any_product_title\": \"Title of an arbitrary product that is part of the order\",\n \"!any_product_sms_text\": \"Sms text of an arbitrary product that is part of the order\",\n \"!any_product_description\": \"Description of an arbitrary product that is part of the order\",\n \"!any_product_vat_percentage\": \"Vat percentage of an arbitrary product that is part of the order\",\n \"!any_product_value\": \"Value of an arbitrary product that is part of the order\",\n \"!any_product_units\": \"Nr of units from an arbitrary product that is part of the order\",\n \"!any_product_unit_price\": \"Price per unit from an arbitrary product that is part of the order\",\n \"!any_product_meeting_start\": \"Start of meeting of an arbitrary product that is part of the order\",\n \"!any_product_meeting_end\": \"End of meeting of an arbitrary product that is part of the order\",\n \"!any_product_field_name_[id]\": \"Product custom field name of custom field with id [id]\",\n \"!any_product_field_[id]\": \"Product custom field value of custom field with id [id]\",\n \"!foreach_product_comma(...)\": \"List each product formated by ... and separated by a comma\",\n \"!foreach_product_newline(...)\": \"List each product formated by ... and separated by a newline\",\n \"!product_id\": \"ID of product\",\n \"!product_artnr\": \"Art.nr of product\",\n \"!product_title\": \"Title of product\",\n \"!product_sms_text\": \"Sms text of product\",\n \"!product_description\": \"Description of product\",\n \"!product_vat_percentage\": \"Vat percentage of product\",\n \"!product_value\": \"Total value of product (!product_units * !product_unit_price)\",\n \"!product_units\": \"Nr of units of product\",\n \"!product_unit_price\": \"Price per unit of the product\",\n \"!meeting_start\": \"Start date and time of the calendar event that is associated with the product\",\n \"!meeting_end\": \"End date and time of the calendar event that is associated with the product\",\n \"!product_field_name_[id]\": \"Product custom field name of custom field with id [id]\",\n \"!product_field_[id]\": \"Product custom field value of custom field with id [id]\"\n}"}],"_postman_id":"4247ed91-32e3-4346-82aa-1751f34a80c5"},{"name":"Create sms template","id":"42306369-0d46-4073-a038-c513add238b6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"title\": \"str\",\r\n \"content\": \"str\",\r\n \"office_id\": int\r\n}","options":{"raw":{"language":"json"}}},"url":"{your_dialer}.hitrate.tech:3007/api/sms_template","description":"Creates a new sms template to be used. Title and content are required.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{API token}"}]},"isInherited":true,"source":{"_postman_id":"023d17ad-66f9-41ca-b576-cc71fb619feb","id":"023d17ad-66f9-41ca-b576-cc71fb619feb","name":"HitrateAPI 1.4.4","type":"collection"}},"urlObject":{"port":"3007","path":["api","sms_template"],"host":["{your_dialer}.hitrate.tech"],"query":[],"variable":[]}},"response":[{"id":"587ae41f-e2f4-4361-a7ed-9d3ce870cf8a","name":"Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"title\": \"str\",\r\n \"content\": \"str\",\r\n \"office_id\": 1\r\n}","options":{"raw":{"language":"json"}}},"url":"{your_dialer}.hitrate.tech:3007/api/sms_template"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"29"},{"key":"etag","value":"W/\"1d-RmiouQlWBVnt5DuO0k/k+LTXu08\""},{"key":"date","value":"Fri, 04 Jul 2025 13:57:38 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"id\": 102\n}"},{"id":"f158cc9e-f309-4b2b-9c52-0fed4501b8f3","name":"Missing title","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"content\": \"A sms template\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{Dialer URL}}:3007/api/sms_template"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"105"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Tue, 11 Jun 2024 09:43:38 GMT"},{"key":"Etag","value":"W/\"69-e/D6R+gKu4OpxFRB+N9a+uWSYjY\""},{"key":"X-Powered-By","value":"Express"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Error\",\n \"code\": 1,\n \"str\": \"Validation error\",\n \"replacements\": {},\n \"extra\": [\n [\n \"title\",\n \"is required!\"\n ]\n ]\n}"},{"id":"ffe290ba-c56d-4dff-9346-6e23264d3f8e","name":"Missing content","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"title\": \"str\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{Dialer URL}}:3007/api/sms_template"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"107"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Tue, 11 Jun 2024 09:43:56 GMT"},{"key":"Etag","value":"W/\"6b-lSZUm/ts9HdeNWkxC0W+GOrja3M\""},{"key":"X-Powered-By","value":"Express"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Error\",\n \"code\": 1,\n \"str\": \"Validation error\",\n \"replacements\": {},\n \"extra\": [\n [\n \"content\",\n \"is required!\"\n ]\n ]\n}"}],"_postman_id":"42306369-0d46-4073-a038-c513add238b6"},{"name":"Update sms template","id":"49a16daf-7303-4910-9dd3-ffd9c3fcbe8f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"title\": \"str\",\r\n \"content\": \"str\",\r\n \"office_id\": int\r\n}","options":{"raw":{"language":"json"}}},"url":"{your_dialer}.hitrate.tech:3007/api/sms_template/:id","description":"As with our other PUT endpoints, any key not included in the body will have it's data unchanged.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{API token}"}]},"isInherited":true,"source":{"_postman_id":"023d17ad-66f9-41ca-b576-cc71fb619feb","id":"023d17ad-66f9-41ca-b576-cc71fb619feb","name":"HitrateAPI 1.4.4","type":"collection"}},"urlObject":{"port":"3007","path":["api","sms_template",":id"],"host":["{your_dialer}.hitrate.tech"],"query":[],"variable":[{"description":{"content":"Id of the sms tempalte to update
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"3dd13332-a15a-4fd0-bf52-00cf77dcde76","name":"Update Success","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"title\": \"SMS testing template\",\r\n \"content\": \"Hello !firstname I am a SMS template and I am looking for a home. Can you help me by answering ok to test sms valdiation? Regards, Hitrate\",\r\n \"office_id\": null\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{{Dialer URL}}:3007/api/sms_template/:id","protocol":"https","host":["{{Dialer URL}}"],"port":"3007","path":["api","sms_template",":id"],"variable":[{"key":"id","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"192"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Wed, 12 Jun 2024 12:34:09 GMT"},{"key":"Etag","value":"W/\"c0-9K2zXGwhrzbiaNQMJh99lVz+4fs\""},{"key":"X-Powered-By","value":"Express"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"1\",\n \"title\": \"SMS testing template\",\n \"content\": \"Hello !firstname I am a SMS template and I am looking for a home. Can you help me by answering ok to test sms valdiation? Regards, Hitrate\",\n \"office_id\": null\n}"},{"id":"a0f11844-147f-4846-bf6a-92608522685a","name":"Misisng body","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"title\": \"str\",\r\n \"content\": \"str\",\r\n \"office_id\": int\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{your_dialer}.hitrate.tech:3007/api/sms_template/:id","host":["{your_dialer}.hitrate.tech"],"port":"3007","path":["api","sms_template",":id"],"variable":[{"key":"id","value":"102","description":"Id of the sms tempalte to update"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"39"},{"key":"etag","value":"W/\"27-i3tG9mG6njBolj6PNSfbIf4ghr4\""},{"key":"date","value":"Fri, 04 Jul 2025 14:01:12 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"body parameters are empty\"\n}"}],"_postman_id":"49a16daf-7303-4910-9dd3-ffd9c3fcbe8f"},{"name":"Delete sms template","id":"786731be-78e9-4932-b67b-50232a4ef2ec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"{your_dialer}.hitrate.tech:3007/api/sms_template/:id","description":"Removes the template from the dialer and any product/call result/notification it has been set as.
\nThis action can be reversed with the help of a Hitrate admin or support.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{API token}"}]},"isInherited":true,"source":{"_postman_id":"023d17ad-66f9-41ca-b576-cc71fb619feb","id":"023d17ad-66f9-41ca-b576-cc71fb619feb","name":"HitrateAPI 1.4.4","type":"collection"}},"urlObject":{"port":"3007","path":["api","sms_template",":id"],"host":["{your_dialer}.hitrate.tech"],"query":[],"variable":[{"description":{"content":"Id of the tempalte to be deleted
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"7d648615-1249-4715-a19f-60c6caba50e7","name":"Succesful deletion","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://{{Dialer URL}}:3007/api/sms_template/:id","protocol":"https","host":["{{Dialer URL}}"],"port":"3007","path":["api","sms_template",":id"],"variable":[{"key":"id","value":"23"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"52"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Wed, 12 Jun 2024 13:43:47 GMT"},{"key":"Etag","value":"W/\"34-0oEoHcb8KEqnULHI5oNPp0nun54\""},{"key":"X-Powered-By","value":"Express"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"23\",\n \"message\": \"Sms template is deleted\"\n}"},{"id":"42c98ab5-0e90-4f90-83e7-340fc686a862","name":"Sms template doesn't exist","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{your_dialer}.hitrate.tech:3007/api/sms_template/:id","host":["{your_dialer}.hitrate.tech"],"port":"3007","path":["api","sms_template",":id"],"variable":[{"key":"id","value":"33333","description":"Id of the tempalte to be deleted"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"58"},{"key":"etag","value":"W/\"3a-NosbaPODE+ecmOwY90JSAPdHflc\""},{"key":"date","value":"Fri, 04 Jul 2025 14:02:49 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Access denied or SMS Template does not exist\"\n}"}],"_postman_id":"786731be-78e9-4932-b67b-50232a4ef2ec"},{"name":"Get sms communications","id":"e0da0169-a544-4741-afcb-929ca00d28ad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\r\n \"customer_id\": int,\r\n \"phonenumber\": string,\r\n \"user_id\": int, //int int[]\r\n \"campaign_id\": int, //int int[]\r\n \"contactlist_id\": int, //int int[]\r\n \"start_date\": date, //str YYYY-MM-DD\r\n \"end_date\": date //str YYYY-MM-DD\r\n}","options":{"raw":{"language":"json"}}},"url":"{your_dialer}.hitrate.tech:3007/api/sms_communications","description":"Get all sms that has been sent and recieved in the system and matches the filter.
\nCall sms - sent when a specific call result is selected
\nOrder sms - sent by agent when placing an order. This will include the template on the order call result and \"sms contact info\" field on the campaign
\nCustomer sms - free two-way sms that allows back and forth communication
\nNotification sms - sent automatically when an order is confirmed (depending on product setting)
\nReminder - is sent either when an order hasn't been confirmed or X amount of time before a booked meeting
\nGet more detailed information on all the sms that has been sent/recieved from a customer.
\nThis includes any number the customer has had.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{API token}"}]},"isInherited":true,"source":{"_postman_id":"023d17ad-66f9-41ca-b576-cc71fb619feb","id":"023d17ad-66f9-41ca-b576-cc71fb619feb","name":"HitrateAPI 1.4.4","type":"collection"}},"urlObject":{"port":"3007","path":["api","sms_communication"],"host":["{your_dialer}.hitrate.tech"],"query":[],"variable":[]}},"response":[{"id":"c0297c7a-25a5-46a9-93b5-9d0c32cbd3e2","name":"Get specific sms history","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\r\n \"customer_id\": 922\r\n //\"phonenumber\": string,\r\n //\"user_id\": int, //int int[]\r\n //\"campaign_id\": int, //int int[]\r\n //\"contactlist_id\": int, //int int[]\r\n //\"start_date\": date, //str YYYY-MM-DD\r\n //\"end_date\": date //str YYYY-MM-DD\r\n}","options":{"raw":{"language":"json"}}},"url":"{your_dialer}.hitrate.tech:3007/api/sms_communication"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"188"},{"key":"etag","value":"W/\"bc-Y0258Q4mkl3quNODKiI/UfH0N+k\""},{"key":"date","value":"Thu, 19 Jun 2025 14:25:12 GMT"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"customer_id\": 922,\n \"phonenumber\": \"+46XXXXXXXX\",\n \"rows\": [\n {\n \"agent\": 6,\n \"message\": \"Manually confirmed by user admin\",\n \"sent\": \"2024-01-05T08:02:57.000Z\",\n \"sender\": \"none\",\n \"sms_type\": \"Order SMS\"\n }\n ]\n}"},{"id":"49ef105e-dba7-4cc6-a378-64816ab3253c","name":"No customer found","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\r\n \"customer_id\": 1\r\n}","options":{"raw":{"language":"json"}}},"url":"{your_dialer}.hitrate.tech:3007/api/sms_communications"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"33"},{"key":"etag","value":"W/\"21-HsLZCjwQB3y6IKILcgYzEVTprfM\""},{"key":"date","value":"Thu, 19 Jun 2025 14:27:32 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"No customer was found\"\n}"}],"_postman_id":"4c611333-575e-4361-a2df-5bfefbc9c54e"},{"name":"Get specific sms history pdf","id":"83949c4e-d6a0-4fff-a257-4ed3d0b6f1a3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\r\n \"customer_id\": int\r\n // \"phonenumber\": string,\r\n // \"user_id\": int, //int int[]\r\n // \"campaign_id\": int, //int int[]\r\n // \"contactlist_id\": int, //int int[]\r\n // \"start_date\": date,\r\n // \"end_date\": date\r\n}","options":{"raw":{"language":"json"}}},"url":"{your_dialer}.hitrate.tech:3007/api/sms_communication/pdf","description":"Returns a PDF file that presents all the sms sent with timestamps and by whom.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{API token}"}]},"isInherited":true,"source":{"_postman_id":"023d17ad-66f9-41ca-b576-cc71fb619feb","id":"023d17ad-66f9-41ca-b576-cc71fb619feb","name":"HitrateAPI 1.4.4","type":"collection"}},"urlObject":{"port":"3007","path":["api","sms_communication","pdf"],"host":["{your_dialer}.hitrate.tech"],"query":[],"variable":[]}},"response":[],"_postman_id":"83949c4e-d6a0-4fff-a257-4ed3d0b6f1a3"}],"id":"b8c77f31-68db-4ad2-85cf-407c088f083c","description":"Create and edit sms templates in the dialer.
\nValues from an order or customer can be used to replace tokens in the sms template itself.
\nThe types of SMS that are supported:
\nAutomatic SMS - based on call result. (Only order call result supports order value replacement)
\nNotification SMS - after an order has been confirmed
\nOrder SMS - sends a template based on the products added to an order and confirms order on valid response
\nCustomer SMS - Two way SMS that can be sent and edited freely
\nLists all users in the dailer.
\nDeleted users have their usernames and passwords destroyed along with all their recurring calls.
\nActive will enable/disable login and listing of them in the dialer, admins can still manually reactive these users.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{API token}"}]},"isInherited":true,"source":{"_postman_id":"023d17ad-66f9-41ca-b576-cc71fb619feb","id":"023d17ad-66f9-41ca-b576-cc71fb619feb","name":"HitrateAPI 1.4.4","type":"collection"}},"urlObject":{"port":"3007","path":["api","users"],"host":["{your_dialer}.hitrate.tech"],"query":[],"variable":[]}},"response":[{"id":"d2b9baad-9403-4ff8-a493-223d0fa51835","name":"Success","originalRequest":{"method":"GET","header":[],"url":"{your_dialer}.hitrate.tech:3007/api/users"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"5262"},{"key":"etag","value":"W/\"148e-/2ywVOwfkCEdRPWJDlmItfzQV5E\""},{"key":"date","value":"Fri, 04 Jul 2025 13:50:29 GMT"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 2,\n \"username\": \"admin\",\n \"firstname\": \"Hitrate\",\n \"lastname\": \"Support\",\n \"active\": 1,\n \"email\": null,\n \"address\": null,\n \"postal_code\": null,\n \"city\": null,\n \"office\": \"Göteborg\",\n \"role\": [\n 1,\n 3\n ]\n },\n {\n \"id\": 6,\n \"username\": \"mawila\",\n \"firstname\": \"Mawila\",\n \"lastname\": \"Nathaniel\",\n \"active\": 1,\n \"email\": null,\n \"address\": null,\n \"postal_code\": null,\n \"city\": null,\n \"office\": \"Göteborg\",\n \"role\": [\n 1,\n 3\n ]\n },\n {\n \"id\": 10,\n \"username\": \"mawilaN\",\n \"firstname\": \"Mawila\",\n \"lastname\": \"Max\",\n \"active\": 1,\n \"email\": null,\n \"address\": null,\n \"postal_code\": null,\n \"city\": null,\n \"office\": \"Göteborg\",\n \"role\": [\n 3\n ]\n },\n {\n \"id\": 14,\n \"username\": \"david\",\n \"firstname\": \"David\",\n \"lastname\": \"Kaktus\",\n \"active\": 1,\n \"email\": \"david@hitrate.tech\",\n \"address\": null,\n \"postal_code\": null,\n \"city\": null,\n \"office\": \"Göteborg\",\n \"role\": [\n 1,\n 3\n ]\n },\n {\n \"id\": 18,\n \"username\": \"leif\",\n \"firstname\": \"Leif\",\n \"lastname\": \"Oskarsson\",\n \"active\": 1,\n \"email\": \"test@email.com\",\n \"address\": null,\n \"postal_code\": null,\n \"city\": null,\n \"office\": \"Göteborg\",\n \"role\": [\n 1,\n 2,\n 3\n ]\n },\n {\n \"id\": 22,\n \"username\": \"fredrik\",\n \"firstname\": \"Fredrik\",\n \"lastname\": \"Uppholm\",\n \"active\": 1,\n \"email\": null,\n \"address\": null,\n \"postal_code\": null,\n \"city\": null,\n \"office\": \"Uppsala\",\n \"role\": [\n 3\n ]\n },\n {\n \"id\": 26,\n \"username\": \"axel\",\n \"firstname\": \"Axel\",\n \"lastname\": \"Gransson\",\n \"active\": 1,\n \"email\": null,\n \"address\": null,\n \"postal_code\": null,\n \"city\": null,\n \"office\": \"Göteborg\",\n \"role\": [\n 1,\n 3\n ]\n },\n {\n \"id\": 30,\n \"username\": \"axel2\",\n \"firstname\": \"Axel\",\n \"lastname\": \"2\",\n \"active\": 1,\n \"email\": null,\n \"address\": null,\n \"postal_code\": null,\n \"city\": null,\n \"office\": \"Göteborg\",\n \"role\": [\n 3\n ]\n },\n {\n \"id\": 34,\n \"username\": \"adam\",\n \"firstname\": \"Adam\",\n \"lastname\": \"Eriksson\",\n \"active\": 1,\n \"email\": null,\n \"address\": null,\n \"postal_code\": null,\n \"city\": null,\n \"office\": \"Göteborg\",\n \"role\": [\n 1,\n 2,\n 3,\n 6,\n 14\n ]\n },\n {\n \"id\": 38,\n \"username\": \"kim\",\n \"firstname\": \"Kim\",\n \"lastname\": \"Nordström\",\n \"active\": 1,\n \"email\": null,\n \"address\": null,\n \"postal_code\": null,\n \"city\": null,\n \"office\": \"Göteborg\",\n \"role\": [\n 1,\n 3,\n 14\n ]\n },\n {\n \"id\": 46,\n \"username\": \"isak\",\n \"firstname\": \"isak\",\n \"lastname\": \"isak\",\n \"active\": 1,\n \"email\": \"isak.cetin@hotmail.com\",\n \"address\": null,\n \"postal_code\": null,\n \"city\": null,\n \"office\": \"Göteborg\",\n \"role\": [\n 1,\n 3\n ]\n },\n {\n \"id\": 50,\n \"username\": \"tt\",\n \"firstname\": \"tt\",\n \"lastname\": \"tt\",\n \"active\": 1,\n \"email\": null,\n \"address\": null,\n \"postal_code\": null,\n \"city\": null,\n \"office\": \"Göteborg\",\n \"role\": [\n 3\n ]\n },\n {\n \"id\": 54,\n \"username\": \"test\",\n \"firstname\": \"test\",\n \"lastname\": \"test\",\n \"active\": 1,\n \"email\": null,\n \"address\": null,\n \"postal_code\": null,\n \"city\": null,\n \"office\": \"Göteborg\",\n \"role\": [\n 3\n ]\n },\n {\n \"id\": 58,\n \"username\": \"matti\",\n \"firstname\": \"matti\",\n \"lastname\": \"matti\",\n \"active\": 1,\n \"email\": null,\n \"address\": null,\n \"postal_code\": null,\n \"city\": null,\n \"office\": \"Göteborg\",\n \"role\": [\n 1,\n 3,\n 14\n ]\n },\n {\n \"id\": 62,\n \"username\": \"mattiagentti\",\n \"firstname\": \"mattiagentti\",\n \"lastname\": \"mattiagentti\",\n \"active\": 1,\n \"email\": null,\n \"address\": null,\n \"postal_code\": null,\n \"city\": null,\n \"office\": \"Göteborg\",\n \"role\": [\n 3\n ]\n },\n {\n \"id\": 66,\n \"username\": \"dennis\",\n \"firstname\": \"Dennis\",\n \"lastname\": \"Dennis\",\n \"active\": 1,\n \"email\": null,\n \"address\": null,\n \"postal_code\": null,\n \"city\": null,\n \"office\": \"Göteborg\",\n \"role\": [\n 3\n ]\n },\n {\n \"id\": 70,\n \"username\": \"str\",\n \"firstname\": \"str\",\n \"lastname\": \"str\",\n \"active\": 1,\n \"email\": \"str\",\n \"address\": \"str\",\n \"postal_code\": \"str\",\n \"city\": \"str\",\n \"office\": \"Göteborg\",\n \"role\": [\n 1\n ]\n },\n {\n \"id\": 94,\n \"username\": \"bruno\",\n \"firstname\": \"bruno\",\n \"lastname\": \"brunosson\",\n \"active\": 1,\n \"email\": \"bruno.brunosson@bruno.se\",\n \"address\": \"Brunostigen 8\",\n \"postal_code\": \"70888\",\n \"city\": \"Brunoköping\",\n \"office\": \"Göteborg\",\n \"role\": [\n 1,\n 3\n ]\n },\n {\n \"id\": 110,\n \"username\": \"mybruno\",\n \"firstname\": \"mybruno\",\n \"lastname\": \"mybrunosson\",\n \"active\": 1,\n \"email\": \"mybruno.brunosson@bruno.se\",\n \"address\": \"Brunostigen 8\",\n \"postal_code\": \"70888\",\n \"city\": \"Brunoköping\",\n \"office\": \"Göteborg\",\n \"role\": [\n 1\n ]\n },\n {\n \"id\": 118,\n \"username\": \"mybrunoz\",\n \"firstname\": \"mybruno\",\n \"lastname\": \"mybrunosson\",\n \"active\": 1,\n \"email\": \"mybruno.brunosson@bruno.se\",\n \"address\": \"Brunostigen 8\",\n \"postal_code\": \"70888\",\n \"city\": \"Brunoköping\",\n \"office\": \"Göteborg\",\n \"role\": [\n 1\n ]\n },\n {\n \"id\": 122,\n \"username\": \"mybrunozz\",\n \"firstname\": \"mybruno\",\n \"lastname\": \"mybrunosson\",\n \"active\": 1,\n \"email\": \"mybruno.brunosson@bruno.se\",\n \"address\": \"Brunostigen 8\",\n \"postal_code\": \"70888\",\n \"city\": \"Brunoköping\",\n \"office\": \"Göteborg\",\n \"role\": [\n 1\n ]\n },\n {\n \"id\": 126,\n \"username\": \"deleteME\",\n \"firstname\": \"Delete ME\",\n \"lastname\": \"Now!!\",\n \"active\": 0,\n \"email\": null,\n \"address\": null,\n \"postal_code\": null,\n \"city\": null,\n \"office\": \"Göteborg\",\n \"role\": [\n 3\n ]\n },\n {\n \"id\": 130,\n \"username\": \"bruno_user\",\n \"firstname\": \"mybrunosz\",\n \"lastname\": \"zz\",\n \"active\": 1,\n \"email\": \"isse.cetin@hotmail.com\",\n \"address\": \"KG 10\",\n \"postal_code\": \"70310\",\n \"city\": \"Örebro\",\n \"office\": \"Örebro\",\n \"role\": [\n 1\n ]\n },\n {\n \"id\": 134,\n \"username\": \"bruno_user15\",\n \"firstname\": \"mybrunosz\",\n \"lastname\": \"zz\",\n \"active\": 1,\n \"email\": \"isse.cetin@hotmail.com\",\n \"address\": \"KG 10\",\n \"postal_code\": \"70310\",\n \"city\": \"Örebro\",\n \"office\": \"Örebro\",\n \"role\": [\n 1\n ]\n },\n {\n \"id\": 138,\n \"username\": \"mybruno19\",\n \"firstname\": \"mybruno\",\n \"lastname\": \"mybrunosson\",\n \"active\": 1,\n \"email\": \"mybruno.brunosson@bruno.se\",\n \"address\": \"Brunostigen 8\",\n \"postal_code\": \"70888\",\n \"city\": \"Brunoköping\",\n \"office\": \"Göteborg\",\n \"role\": [\n 1\n ]\n },\n {\n \"id\": 142,\n \"username\": \"bjorn\",\n \"firstname\": \"bjorn\",\n \"lastname\": \"bjorn\",\n \"active\": 1,\n \"email\": null,\n \"address\": null,\n \"postal_code\": null,\n \"city\": null,\n \"office\": \"Göteborg\",\n \"role\": [\n 1,\n 2,\n 3,\n 10\n ]\n },\n {\n \"id\": 146,\n \"username\": \"bjorn2\",\n \"firstname\": \"bjorn2\",\n \"lastname\": \"bjorn2\",\n \"active\": 1,\n \"email\": null,\n \"address\": null,\n \"postal_code\": null,\n \"city\": null,\n \"office\": \"Göteborg\",\n \"role\": [\n 3\n ]\n },\n {\n \"id\": 150,\n \"username\": \"jonathan\",\n \"firstname\": \"Jonathan\",\n \"lastname\": \"jonathan\",\n \"active\": 1,\n \"email\": null,\n \"address\": null,\n \"postal_code\": null,\n \"city\": null,\n \"office\": \"Göteborg\",\n \"role\": [\n 1,\n 3\n ]\n }\n]"}],"_postman_id":"99ebfa42-202c-4112-88fb-86d09a3a66f4"},{"name":"List specific user","id":"080b0635-ce10-430d-9720-a50ffb5d0103","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{your_dialer}.hitrate.tech:3007/api/user/:id","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{API token}"}]},"isInherited":true,"source":{"_postman_id":"023d17ad-66f9-41ca-b576-cc71fb619feb","id":"023d17ad-66f9-41ca-b576-cc71fb619feb","name":"HitrateAPI 1.4.4","type":"collection"}},"urlObject":{"port":"3007","path":["api","user",":id"],"host":["{your_dialer}.hitrate.tech"],"query":[],"variable":[{"id":"96f4cc82-799d-4e0a-ac77-18490102c97e","description":{"content":"Specific user to list
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"fcafd60e-eac3-4815-8448-9018c9f96420","name":"Succesful","originalRequest":{"method":"GET","header":[],"url":{"raw":"{your_dialer}.hitrate.tech:3007/api/user/:id","host":["{your_dialer}.hitrate.tech"],"port":"3007","path":["api","user",":id"],"variable":[{"key":"id","value":"6","description":"Specific user to list"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"176"},{"key":"etag","value":"W/\"b0-JfsQAKseEUThOYYn5RHcz0wJpQA\""},{"key":"date","value":"Fri, 04 Jul 2025 13:49:30 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 6,\n \"username\": \"mawila\",\n \"firstname\": \"Mawila\",\n \"lastname\": \"Nathaniel\",\n \"active\": 1,\n \"email\": null,\n \"address\": null,\n \"postal_code\": null,\n \"city\": null,\n \"office\": \"Göteborg\",\n \"role\": [\n 1,\n 3\n ]\n}"},{"id":"61a43ea6-2c2b-40f7-8244-5f564bfff7b2","name":"Wrong ID format","originalRequest":{"method":"GET","header":[],"url":{"raw":"{your_dialer}.hitrate.tech:3007/api/user/:id","host":["{your_dialer}.hitrate.tech"],"port":"3007","path":["api","user",":id"],"variable":[{"key":"id","value":"","description":"Specific user to list"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"31"},{"key":"etag","value":"W/\"1f-ElQmEbiAwyO8cJsSwuy4fjnpttY\""},{"key":"date","value":"Tue, 01 Jul 2025 06:37:46 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Invalid ID format\"\n}"},{"id":"e009a75f-b214-4e99-bdc3-3a222e09aa58","name":"User not found","originalRequest":{"method":"GET","header":[],"url":{"raw":"{your_dialer}.hitrate.tech:3007/api/user/:id","host":["{your_dialer}.hitrate.tech"],"port":"3007","path":["api","user",":id"],"variable":[{"key":"id","value":"879474869","description":"Specific user to list"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"28"},{"key":"etag","value":"W/\"1c-ZEVVcvtFhxKX/QUvVKqKxwGbbNA\""},{"key":"date","value":"Tue, 01 Jul 2025 06:38:25 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"User not found\"\n}"}],"_postman_id":"080b0635-ce10-430d-9720-a50ffb5d0103"},{"name":"List offices","id":"d003b2ba-8990-4f44-a38d-4bf1f6dfe04f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{your_dialer}.hitrate.tech:3007/api/users/office","description":"Get all the offices in the dailer, or the ones you are a part of if you are part of a limited office.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{API token}"}]},"isInherited":true,"source":{"_postman_id":"023d17ad-66f9-41ca-b576-cc71fb619feb","id":"023d17ad-66f9-41ca-b576-cc71fb619feb","name":"HitrateAPI 1.4.4","type":"collection"}},"urlObject":{"port":"3007","path":["api","users","office"],"host":["{your_dialer}.hitrate.tech"],"query":[],"variable":[]}},"response":[{"id":"23f5b1f2-75d7-46d4-83c1-6a81a67f8baf","name":"List offices","originalRequest":{"method":"GET","header":[],"url":"https://{{Dialer URL}}:3007/api/users/office"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"103"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Wed, 03 Jul 2024 13:41:36 GMT"},{"key":"Etag","value":"W/\"67-rfpENCAV3YgnFHDnXeutFJKfYP8\""},{"key":"X-Powered-By","value":"Express"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 1,\n \"name\": \"World\"\n },\n {\n \"id\": 2,\n \"name\": \"New York\"\n },\n {\n \"id\": 3,\n \"name\": \"London\"\n },\n {\n \"id\": 4,\n \"name\": \"Stockholm\"\n }\n]"}],"_postman_id":"d003b2ba-8990-4f44-a38d-4bf1f6dfe04f"},{"name":"Create new user","id":"89d90c31-fb6d-4b6a-8012-83097962d53f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"username\": \"str\", //Required\r\n \"password\": \"str\", //Required\r\n \"firstname\": \"str\", //Required\r\n \"lastname\": \"str\", //Required\r\n \"email\": \"str\",\r\n \"hire_date\": date,\r\n \"language_id\": int,\r\n \"address\": \"str\",\r\n \"postal_code\": \"str\",\r\n \"city\": \"str\",\r\n \"office_id\": int,\r\n \"role\": [\r\n 1\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{your_dialer}.hitrate.tech:3007/api/user","description":"Keep in mind that the license limits counts users that are logged in at the same time. There's no limit to any active users a dailer can have no matter how many licenses the dailer has.
\nEach username has to be unique, any deleted user has their username freed up for use by someone else.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{API token}"}]},"isInherited":true,"source":{"_postman_id":"023d17ad-66f9-41ca-b576-cc71fb619feb","id":"023d17ad-66f9-41ca-b576-cc71fb619feb","name":"HitrateAPI 1.4.4","type":"collection"}},"urlObject":{"port":"3007","path":["api","user"],"host":["{your_dialer}.hitrate.tech"],"query":[],"variable":[]}},"response":[{"id":"44731af0-d71d-444d-9064-6da7180f4387","name":"User created","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"username\": \"Example1\",\r\n \"password\": \"aStrongPassword\",\r\n \"firstname\": \"Test\",\r\n \"lastname\": \"User\",\r\n \"email\": \"test@email.com\",\r\n \"hiredate\": \"2023-01-01\",\r\n \"language_id\": 1,\r\n \"address\": \"Drottninggatan 1\",\r\n \"postal_code\": \"11345\",\r\n \"city\": \"Stockholm\",\r\n \"office_id\": 3,\r\n \"role\": [\r\n 2\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{Dialer URL}}:3007/api/user"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"28"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Wed, 03 Jul 2024 13:43:16 GMT"},{"key":"Etag","value":"W/\"1c-9P0CpQvQKsFMYV/cT+zfdnjnKec\""},{"key":"X-Powered-By","value":"Express"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"id\": 11\n}"},{"id":"08557f0e-93fa-4c27-b4ce-742f3856319f","name":"Missing required parameters","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n}","options":{"raw":{"language":"json"}}},"url":"{your_dialer}.hitrate.tech:3007/api/user"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"230"},{"key":"etag","value":"W/\"e6-uG7b0ONarXPmmy4iKRabbfq+M7I\""},{"key":"date","value":"Fri, 04 Jul 2025 13:48:07 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": [\n \"username is required when creating users\",\n \"password is required when creating users\",\n \"firstname is required when creating users\",\n \"lastname is required when creating users\",\n \"office_id is required when creating users\"\n ]\n}"},{"id":"be4b4fe5-f637-4a2f-a57d-4dcca61bb9b1","name":"Username already in use","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"username\": \"david\", //Required\r\n \"password\": \"david\", //Required\r\n \"firstname\": \"david\", //Required\r\n \"lastname\": \"david\", //Required\r\n \"office_id\": 1,\r\n \"role\": [\r\n 1\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{your_dialer}.hitrate.tech:3007/api/user"},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"41"},{"key":"etag","value":"W/\"29-NskX23IfgBTdJwv5A9iBP6RDK/0\""},{"key":"date","value":"Fri, 04 Jul 2025 13:48:38 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"this username already exist\"\n}"}],"_postman_id":"89d90c31-fb6d-4b6a-8012-83097962d53f"},{"name":"Update user","id":"86110001-4c95-4492-9783-85669668e547","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"username\": \"str\",\r\n \"password\": \"str\",\r\n \"firstname\": \"str\",\r\n \"lastname\": \"str\",\r\n \"email\": \"str\",\r\n \"hiredate\": date,\r\n \"language_id\": int,\r\n \"address\": \"str\",\r\n \"postal_code\": \"str\",\r\n \"city\": \"str\",\r\n \"active\": boolean,\r\n \"role\": [\r\n 1\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{your_dialer}.hitrate.tech:3007/api/user/:id","description":"Update a user's information, only data that is included in the body will be updated, anything omitted will remain the same.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{API token}"}]},"isInherited":true,"source":{"_postman_id":"023d17ad-66f9-41ca-b576-cc71fb619feb","id":"023d17ad-66f9-41ca-b576-cc71fb619feb","name":"HitrateAPI 1.4.4","type":"collection"}},"urlObject":{"port":"3007","path":["api","user",":id"],"host":["{your_dialer}.hitrate.tech"],"query":[],"variable":[{"description":{"content":"Id of the user to update
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"aeaac275-c299-472b-930f-66953b9ac477","name":"Update user success","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"username\": \"str\",\r\n \"password\": \"str\",\r\n \"firstname\": \"str\",\r\n \"lastname\": \"str\",\r\n \"email\": \"str\",\r\n \"hiredate\": \"2021-02-11\",\r\n \"language_id\": 1,\r\n \"address\": \"str\",\r\n \"postal_code\": \"str\",\r\n \"city\": \"str\",\r\n \"active\": 1,\r\n \"role\": [\r\n 1\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{your_dialer}.hitrate.tech:3007/api/user/23"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"267"},{"key":"etag","value":"W/\"10b-cDRfdjikuawqRCLg0+HrQHy21A4\""},{"key":"date","value":"Fri, 30 Aug 2024 11:43:47 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"23\",\n \"username\": \"str\",\n \"password\": \"8dda59c1e50a59c5ab1405bb768ecaa2ffc114e2afaf87501511f49cf679cebb\",\n \"firstname\": \"str\",\n \"lastname\": \"str\",\n \"email\": \"str\",\n \"hire_date\": \"2021-02-11\",\n \"language_id\": 1,\n \"address\": \"str\",\n \"postal_code\": \"str\",\n \"city\": \"str\",\n \"active\": 1,\n \"role\": [\n 1\n ]\n}"},{"id":"bc5a7f5a-faa0-4f26-8ce9-ef16d28b300a","name":"Username already in use","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"username\": \"test\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{your_dialer}.hitrate.tech:3007/api/user/:id","host":["{your_dialer}.hitrate.tech"],"port":"3007","path":["api","user",":id"],"variable":[{"key":"id","value":"6","description":"Id of the user to update"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"36"},{"key":"etag","value":"W/\"24-VWWwfQVGljYgYlmoY2EG0s/DuUY\""},{"key":"date","value":"Fri, 04 Jul 2025 13:37:07 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"username already exist\"\n}"},{"id":"fa4146d4-696d-490e-8b45-0dbed3a04e1f","name":"One value being wrong format","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"firstname\": \"test\",\r\n \"hiredate\": \"I am wrong\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{your_dialer}.hitrate.tech:3007/api/user/:id","host":["{your_dialer}.hitrate.tech"],"port":"3007","path":["api","user",":id"],"variable":[{"key":"id","value":"6","description":"Id of the user to update"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"29"},{"key":"etag","value":"W/\"1d-eemJIVLptwA8ymBo0uU+8YNeHA0\""},{"key":"date","value":"Fri, 04 Jul 2025 13:41:10 GMT"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"id\": 6,\n \"firstname\": \"test\"\n}"}],"_postman_id":"86110001-4c95-4492-9783-85669668e547"},{"name":"Delete user","id":"7b4a61fe-2528-4b43-8497-41c569ba00fb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"{your_dialer}.hitrate.tech:3007/api/user/:id","description":"Removes the user from the dialer UI and destroys the username and password and makes all the agents recurring calls public.
\nIt would be advised to instead set a user to inactive if the user were to be used again in the future.
\nCan be recreated with the help from our support.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{API token}"}]},"isInherited":true,"source":{"_postman_id":"023d17ad-66f9-41ca-b576-cc71fb619feb","id":"023d17ad-66f9-41ca-b576-cc71fb619feb","name":"HitrateAPI 1.4.4","type":"collection"}},"urlObject":{"port":"3007","path":["api","user",":id"],"host":["{your_dialer}.hitrate.tech"],"query":[],"variable":[{"id":"f3e2754e-3630-4937-a184-327900f92520","type":"any","value":"","key":"id"}]}},"response":[{"id":"9134e04d-d256-49f6-a268-07779b7b03f0","name":"User deleted","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://{{Dialer URL}}:3007/api/user/:id","protocol":"https","host":["{{Dialer URL}}"],"port":"3007","path":["api","user",":id"],"variable":[{"key":"id","value":"3"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"38"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Tue, 28 May 2024 07:29:28 GMT"},{"key":"Etag","value":"W/\"26-qhn1WBUb9h4KhD727MGl2sXddRM\""},{"key":"X-Powered-By","value":"Express"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"3\",\n \"message\": \"User is deleted\"\n}"},{"id":"4c0ef733-272a-40f7-8968-9cdda3c97ef8","name":"User not found","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{your_dialer}.hitrate.tech:3007/api/user/:id","host":["{your_dialer}.hitrate.tech"],"port":"3007","path":["api","user",":id"],"variable":[{"key":"id","value":"123123123"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"28"},{"key":"etag","value":"W/\"1c-ZEVVcvtFhxKX/QUvVKqKxwGbbNA\""},{"key":"date","value":"Fri, 04 Jul 2025 13:35:05 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"User not found\"\n}"},{"id":"387a6dc8-5a10-4b7f-972a-d96bfe7d4c5f","name":"Lacking permission","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{your_dialer}.hitrate.tech:3007/api/user/:id","host":["{your_dialer}.hitrate.tech"],"port":"3007","path":["api","user",":id"],"variable":[{"key":"id","value":"8"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"31"},{"key":"etag","value":"W/\"1f-wt2g2dS9WAWcvXLmMgdzZD5hIbI\""},{"key":"date","value":"Fri, 04 Jul 2025 13:35:18 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"permission denied\"\n}"}],"_postman_id":"7b4a61fe-2528-4b43-8497-41c569ba00fb"}],"id":"144303b0-637e-46fa-93f1-1af3513b870b","description":"Users are accounts for agents, coaches, or admins to interact with the system.
\nA system license isn't tied to a specific user, each license allows one more simultaneous login, so there's no limit to how many users you can have.
\nSharing users is discouraged, both from a security prespective but also from a statistics point of view.
\n","_postman_id":"144303b0-637e-46fa-93f1-1af3513b870b","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{API token}"}]},"isInherited":true,"source":{"_postman_id":"023d17ad-66f9-41ca-b576-cc71fb619feb","id":"023d17ad-66f9-41ca-b576-cc71fb619feb","name":"HitrateAPI 1.4.4","type":"collection"}}}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{API token}"}]}},"event":[{"listen":"prerequest","script":{"id":"ed98f9f3-a646-455a-b29c-c28e215e07f7","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"ccc0aa35-e176-47da-9940-3c6d042b4e39","type":"text/javascript","exec":[""]}}],"variable":[{"key":"token","value":"{API token}"},{"key":"Dialer_URL","value":"{your_dialer}.hitrate.tech"},{"key":"id","value":"{1-3]","type":"string"}]}