{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"5c1a4e88-936e-46cc-a43f-940703f704ee","name":"ZebraCRM API","description":"<img src=\"https://www.zebracrm.com/wp-content/uploads/2017/01/LOGO_4-1.png\" alt=\"ZebraCRM Logo\">\n\n# Introduction\n\nThis API is for sending and receiving information to and from ZebraCRM.\n\n**Please note! This documentation is a working progress.**\n\n# Overview\n\nIn this documentation, we will give examples and explanations for how to create XML files correctly to connect to ZebraCRM.  \n**Please note that the Tags in the API are case sensitive**\n\nThe options for the API_CALL are\n\n## ZebraCRM API Functions and URL\n\n### API URL\n\nThe base URL for all API calls is  \n`https://{{ZEBRA_ID}}.zebracrm.com/ext_interface.php?b={{API_CALL}}`  \nThe ZEBRA_ID is the ZebraCRM system number. The API_CALL options are in the following table of functions.  \nWith the ZebraCRM API, you can do the following actions in ZebraCRM\n\n| API call / XML tag | Title | Description | Documentation link |\n| --- | --- | --- | --- |\n| `add_customer` | Creating Customer cards | Create new cards in ZebraCRM with the information you wish | [API Documentation](https://../14343450/Tzm5Jxfs#b3e00d42-b5ea-43de-9972-263c25952f34) |\n| `update_customer` | Update existing Customer Cards | Set your own identifier field from that card type and Update any existing card with new or updated information | [API Documentation](https://../14343450/Tzm5Jxfs#b3e00d42-b5ea-43de-9972-263c25952f34) |\n| `add_document` | Create financial documents | Create Invoices, Invoice/Receipts, Quotes and more. | [API Documentation](https://../14343450/Tzm5Jxfs#2a635e8c-9333-44a8-bc61-1c70b2cf0a60) |\n| `add_subscriber` | Create Subscriptions | Create a subscription in ZebraCRM which will periodically create a financial document | [API Documentation](https://../14343450/Tzm5Jxfs#2a635e8c-9333-44a8-bc61-1c70b2cf0a60) |\n| `add_event` | Create event | Add new event in calendar | [API Documentation](https://../14343450/Tzm5Jxfs#51cacd5c-26de-4d21-bcfc-aa3a7b8c707d) |\n|  | Add Module entries | Add entries to a module inside a customer card | [API Documentation](https://../14343450/Tzm5Jxfs#8337e5a1-0ad9-4725-8246-4fa604a6e169) |\n|  | Upload file | Upload file to a module in a customer card encoded in Base64 | [API Documentation](https://../14343450/Tzm5Jxfs#46a78a4b-9893-4306-a5f3-c7639844643f) |\n|  | Add contacts | Add contacts to a customer card | [API Documentation](https://../14343450/Tzm5Jxfs#3777dc39-c121-4c88-b393-b58f5b82acde) |\n|  | Update Status | Update the Status of a Focus in a customer card | [API Documentation](https://../14343450/Tzm5Jxfs#3777dc39-c121-4c88-b393-b58f5b82acde) |\n|  | Connect Cards | Create a connection between cards in the system. **Please note that you first need to create the connection in ZebraCRM** | [API Documentation](https://../14343450/Tzm5Jxfs#3777dc39-c121-4c88-b393-b58f5b82acde) |\n|  | Special Cases | There are various special cases in the API which will be explained in the documentation | [API Documentation](https://../14343450/Tzm5Jxfs#1b2bf946-ec2d-4a92-9b0d-a81d9a048bef) |\n\n# Authentication\n\nTo use the API, you need the username and password of a user in an active ZebraCRM system.  \nThe username and password need to be sent as tags in the `PERMISSION` tag.\n\n# Error Codes\n\nThere are multiple errors you may encounter, the errors explain what went wrong.\n\n# Data Formats\n\nSome of the information types must follow rules to be inputted into ZebraCRM.\n\n| Data Type | Format / Rule |\n| --- | --- |\n| Date | `dd/mm/yyyy` |\n| Teudat Zehut (ID Number) | Must follow the Israeli ID algorithm |\n| Files | Base64 encoded of files from these formats: GIF, JPEG, JPG, PNG, BMP, PDF, HTML |","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":true,"owner":"14343450","collectionId":"5c1a4e88-936e-46cc-a43f-940703f704ee","publishedId":"Tzm5Jxfs","public":true,"publicUrl":"https://documenter-api.postman.tech/view/14343450/Tzm5Jxfs","privateUrl":"https://go.postman.co/documentation/14343450-5c1a4e88-936e-46cc-a43f-940703f704ee","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.1","publishDate":"2021-07-08T17:15:02.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"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/768118b36f06c94b0306958b980558e6915839447e859fe16906e29d683976f0","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/Tzm5Jxfs"}