{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"fb48c8d4-9898-4238-9a6d-6584dabd4d11","name":"Customerly Public REST API","description":"Customerly API allows you to integrate your platform with Customerly's suite of customer support, marketing automation, and customer satisfaction software. This document provides an overview of how to authenticate and interact with the Customerly API.\n\n# Authentication\n\nTo interact with the Customerly REST API, you must authenticate your requests using an access token.\n\n## Get Access Token\n\n1. Log in to Customerly.\n    \n2. Follow the Tutorial: [How to Obtain Your API Access Token in Customerly](https://docs.customerly.io/en/api/how-to-obtain-your-api-access-token-in-customerly).\n    \n\n## Using Access Token\n\nInclude the access token in the `Authentication` header of your HTTP requests.\n\n# Basics\n\nIn Customerly, it's essential to understand the distinction between Users and Leads, as they represent different types of contacts within the platform. They have specific properties and functionalities that cater to different aspects of customer management. For a complete guide on user properties, refer to the [Contact Properties Documentation](https://docs.customerly.io/en/contacts-lists-and-companies/a-complete-guide-about-contact-properties).\n\n## Contacts: Visitors, Leads and Users\n\nIn Customerly, we provide three distinct categories to help you recognize and communicate with different individuals interacting with your platform: Visitors, Leads, and Users. Understanding these categories is essential for effective engagement and customer management.\n\n### Visitors\n\n**Visitors** are individuals who visit your website without engaging with any features, such as the Live Chat widget. They are anonymous and typically lack identifiable information.\n\n- **Example**: Someone browsing your product pages without initiating a chat or signing up.\n    \n- **Interaction**: None with your platform's interactive features.\n    \n- **Data Collected**: Minimal or none.\n    \n\n### Leads\n\n**Leads** are individuals who have shown some level of interest or engagement, such as starting a conversation through Live Chat. Any email collected through Live Chat is considered a Lead.\n\n- **Example**: Someone who asks a question about your products via Live Chat.\n    \n- **Interaction**: Engaging with Live Chat or other interactive elements.\n    \n- **Data Collected**: Email and possibly other contact information.\n    \n- **Integration**: You can connect Customerly with your Facebook Ads to collect leads and initiate Funnels through tools like Zapier.\n    \n\n### Summary\n\n- **Visitors**: Anonymous browsing without engagement.\n    \n- **Leads**: Initial engagement through Live Chat or similar interactions.\n    \n- **Users**: Registered and fully engaged individuals with detailed profiles.\n    \n\nThese categories help you tailor your communication and marketing strategies, offering personalized experiences based on the individual's engagement level with your platform.\n\nFor more details on how to work with Visitors, Leads, and Users in Customerly, refer to the related guides and documentation.\n\n## Contact Properties\n\nA contact property is a data point on your contact that allows you to store specific information related to that contact. These properties can be both default and customized, depending on your needs. Contact properties are essential for segmenting, filtering, and personalizing interactions with your contacts.\n\n### Components of a Contact Property\n\n- **Name**: The identifier of the property, such as `phone_number`.\n    \n- **Description** (optional): An internal description to help you recognize the property.\n    \n- **Value**: The specific value you want to store for each contact for this property.\n    \n- **Type**: The type of value you will store, such as text, number, boolean, or date.\n    \n\nFor example, the `phone_number` property might have a name of \"Phone Number,\" a type of \"text,\" and store individual phone numbers as values for different contacts.\n\n### Further Reading\n\nContact properties can be powerful tools in managing and understanding your customer base. For a detailed guide on how to utilize contact properties within Customerly, including creating custom properties and managing default ones, refer to:\n\n- [A Complete Guide About Contact Properties](https://docs.customerly.io/en/contacts-lists-and-companies/a-complete-guide-about-contact-properties)\n    \n\nThis guide provides step-by-step instructions and best practices for working with contact properties in your Customerly account.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"11487813","team":1059755,"collectionId":"fb48c8d4-9898-4238-9a6d-6584dabd4d11","publishedId":"2s9Y5Wx3QG","public":true,"publicUrl":"https://documenter-api.postman.tech/view/11487813/2s9Y5Wx3QG","privateUrl":"https://go.postman.co/documentation/11487813-fb48c8d4-9898-4238-9a6d-6584dabd4d11","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"2fb6fa"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":"Customerly REST API"}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/faa86aa6-5bae-4422-8ddd-b36e07879071/TG9nby1DdXN0b21lcmx5LnBuZw==","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"2fb6fa"}},{"name":"light","logo":"https://content.pstmn.io/faa86aa6-5bae-4422-8ddd-b36e07879071/TG9nby1DdXN0b21lcmx5LnBuZw==","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"2fb6fa"}}]}},"version":"8.10.1","publishDate":"2023-08-24T15:44:34.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"Customerly REST API","description":""},"logos":{"logoLight":"https://content.pstmn.io/faa86aa6-5bae-4422-8ddd-b36e07879071/TG9nby1DdXN0b21lcmx5LnBuZw==","logoDark":"https://content.pstmn.io/faa86aa6-5bae-4422-8ddd-b36e07879071/TG9nby1DdXN0b21lcmx5LnBuZw=="}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/c767114afc96ba1d186a07cd7c5ceaeaa45cf9f452e62473c964087d8a7e983a","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2s9Y5Wx3QG"}