![\"ZebraCRM](\"https://www.zebracrm.com/wp-content/uploads/2017/01/LOGO_4-1.png\"){kind=logo}
\n\nThis API is for sending and receiving information to and from ZebraCRM.
\nPlease note! This documentation is a working progress.
\nIn this documentation, we will give examples and explanations for how to create XML files correctly to connect to ZebraCRM.
Please note that the Tags in the API are case sensitive
The options for the API_CALL are
\nThe base URL for all API calls ishttps://{{ZEBRA_ID}}.zebracrm.com/ext_interface.php?b={{API_CALL}}
The ZEBRA_ID is the ZebraCRM system number. The API_CALL options are in the following table of functions.
With the ZebraCRM API, you can do the following actions in ZebraCRM
To use the API, you need the username and password of a user in an active ZebraCRM system.
The username and password need to be sent as tags in the PERMISSION tag.
There are multiple errors you may encounter, the errors explain what went wrong.
\nSome of the information types must follow rules to be inputted into ZebraCRM.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Introduction","slug":"introduction"},{"content":"Overview","slug":"overview"},{"content":"Authentication","slug":"authentication"},{"content":"Error Codes","slug":"error-codes"},{"content":"Data Formats","slug":"data-formats"}],"owner":"14343450","collectionId":"5c1a4e88-936e-46cc-a43f-940703f704ee","publishedId":"Tzm5Jxfs","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2021-07-08T17:15:02.000Z"},"item":[{"name":"Getting started","item":[{"name":"Authentication","id":"7aadc639-bb34-4a0a-b5c1-d3d0af2dec0f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"This tag is required in all requests sent to the CRM as it's used for Authentication.
\nWhen you send an update request, you need to send the identifier for the card you wish to update.
\nThere are a number of options for how to send the identifier.
\nOption 1- Sending the identifier field key in the IDENTIFIER tag. The value will be sent in the relevant field tag inside the CUST_DETAILS tag.
Option 2- Sending the key and value for the identifier field.\nPlease note - This is the option you need to use in the financial APIs
\nOption 3- Sending a number of field key values for the identifier field.\nZebraCRM will search the fields in KEY to find the information in VALUE.
Before you start working on the API make sure you have the following information:
\n12345.zebracrm.com.Get or Post requests to edit or receive information to or from Customer cards, make sure you have the relevant Field IDs.In the following requests, we will explain the basic structure for all API requests sent to ZebraCRM.
\n","_postman_id":"33f799be-c8cc-46b3-90bf-29ed1777f083"},{"name":"Customer cards","item":[{"name":"Get information","item":[{"name":"Get card info - general","id":"a71cd7fa-a991-4bdf-b04a-ebce3a0714db","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"\r\nThis is a general example of the structure of the XML needed to get information from ZebraCRM.\nBy using this function you can receive the following types of information from a card or cards.
\nThe structure is divided into 3 types of tags
\nThe permission tags are the same as in all other ZebraCRM XMLs.\nThe Filter tags are used as the search terms with AND conditioning.\nThe Information tags are the tags of the fields ZebraCRM will return with the information of the cards found in the search.
\nThere are no specifically required tags for this API function to work, but you must send at least 1 of these.
\nThere are no specifically required tags for this API function to work, but you must send at least 1 of these.
\n","urlObject":{"protocol":"https","path":["ext_interface.php"],"host":["{{ZEBRA_ID}}","zebracrm","com"],"query":[{"key":"b","value":"get_multi_cards_details"}],"variable":[]}},"response":[],"_postman_id":"a71cd7fa-a991-4bdf-b04a-ebce3a0714db"},{"name":"Get card info - Various filtering examples","id":"ccfc898e-073e-4423-a376-d5ae5456166a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"\r\nThis is a general example of the structure of the XML needed to get information from ZebraCRM.\nBy using this function you can receive the following types of information from a card or cards.
\nThe structure is divided into 3 types of tags
\nThe permission tags are the same as in all other ZebraCRM XMLs.\nThe Filter tags are used as the search terms with AND conditioning.\nThe Information tags are the tags of the fields ZebraCRM will return with the information of the cards found in the search.
\nThere are no specifically required tags for this API function to work, but you must send at least 1 of these.
\nThere are no specifically required tags for this API function to work, but you must send at least 1 of these.
\n","urlObject":{"protocol":"https","path":["ext_interface.php"],"host":["{{ZEBRA_ID}}","zebracrm","com"],"query":[{"key":"b","value":"get_multi_cards_details"}],"variable":[]}},"response":[],"_postman_id":"ccfc898e-073e-4423-a376-d5ae5456166a"},{"name":"Get card info - Focuses","id":"247cbe55-dee7-4d5d-aadb-7a487851918a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"\r\nThis is an example of the structure of the XML needed to get information from ZebraCRM with filtering by a focus.\nBy using this function you can receive the following types of information from a card or cards.
\nThe structure is divided into 3 types of tags
\nThe permission tags are the same as in all other ZebraCRM XMLs.\nThe Filter tags are used as the search terms with AND conditioning.\nThe Information tags are the tags of the fields ZebraCRM will return with the information of the cards found in the search.
\nIn this example we are using the filters of the card type and Focus in order to get the information of all cards which follow those filtering parameters.
\nThere are no specifically required tags for this API function to work, but you must send at least 1 of these.
\n","urlObject":{"protocol":"https","path":["ext_interface.php"],"host":["{{ZEBRA_ID}}","zebracrm","com"],"query":[{"key":"b","value":"get_multi_cards_details"}],"variable":[]}},"response":[],"_postman_id":"247cbe55-dee7-4d5d-aadb-7a487851918a"},{"name":"Get card info - Fields","id":"82fa2bfd-a865-48f1-9a8f-e36d81e298f1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"\r\nThis is an example of sending just fields for searching and receiving.
\nThe structure is divided into 3 types of tags
\nThe permission tags are the same as in all other ZebraCRM XMLs.\nThe Filter tags are used as the search terms with AND conditioning.\nThe Information tags are the tags of the fields ZebraCRM will return with the information of the cards found in the search.
\nThe FILTERS Top-level tag in this example includes the
The FIELDS Top-level tag in this example includes the first name (P_N) and last name (F_N) cell phone number (CELL) and email address (MAIL). These are the fields ZebraCRM will fill and send back.
There are no specifically required tags for this API function to work, but you must send at least 1 of these.
\nThere are no specifically required tags for this API function to work, but you must send at least 1 of these.
\n","urlObject":{"protocol":"https","path":["ext_interface.php"],"host":["{{ZEBRA_ID}}","zebracrm","com"],"query":[{"key":"b","value":"get_multi_cards_details"}],"variable":[]}},"response":[],"_postman_id":"82fa2bfd-a865-48f1-9a8f-e36d81e298f1"},{"name":"Get card info - Filter by ID","id":"2ad2e03a-da92-4a31-bbd8-685b5ae9eb2f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"\r\nThis is a general example of the structure of the XML needed to get information from ZebraCRM.\nBy using this function you can receive the following types of information from a card or cards.
\nThe structure is divided into 3 types of tags
\nThe permission tags are the same as in all other ZebraCRM XMLs.\nThe Filter tags are used as the search terms with AND conditioning.\nThe Information tags are the tags of the fields ZebraCRM will return with the information of the cards found in the search.
\nThere are no specifically required tags for this API function to work, but you must send at least 1 of these.
\nThere are no specifically required tags for this API function to work, but you must send at least 1 of these.
\n","urlObject":{"protocol":"https","path":["ext_interface.php"],"host":["{{ZEBRA_ID}}","zebracrm","com"],"query":[{"key":"b","value":"get_multi_cards_details"}],"variable":[]}},"response":[],"_postman_id":"2ad2e03a-da92-4a31-bbd8-685b5ae9eb2f"},{"name":"Get card info - Files","id":"db67af18-0351-45f4-ba9d-90466b18313c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":" \r\nThis is an example of the structure of the XML needed to get information from ZebraCRM including files.\nYou can receive files only from the archive and only in base64 format.\nWith the file, you will also receive additional information such as the title and file name.
\nThe structure is divided into 3 types of tags
\nThe permission tags are the same as in all other ZebraCRM XMLs.\nThe Filter tags are used as the search terms with AND conditioning.\nThe Information tags are the tags of the fields ZebraCRM will return with the information of the cards found in the search.
\nThere are no specifically required tags for this API function to work, but you must send at least 1 of these.
\nThere are no specifically required tags for this API function to work, but you must send at least 1 of these.
\nWith the file information you will receive the following information in the following tags.
\nIn cases where there are a number of files, you will receive all files, unless you filter by one of these tags when you send the request.
\n","urlObject":{"protocol":"https","path":["ext_interface.php"],"host":["{{ZEBRA_ID}}","zebracrm","com"],"query":[{"key":"b","value":"get_multi_cards_details"}],"variable":[]}},"response":[],"_postman_id":"db67af18-0351-45f4-ba9d-90466b18313c"},{"name":"Get card info - Modules","id":"ab3f811c-8457-4ed0-b62e-c51ba27d8cfa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"\r\nThis is an example of receiving information from a module in the found card.\nNote that module information can only be from a card you filtered a different way. You can't filter cards by module information
\nThe structure is divided into 3 types of tags
\nThe permission tags are the same as in all other ZebraCRM XMLs.\nThe Filter tags are used as the search terms with AND conditioning.
\nThe MODULES Top-level tag has a the following structure.
There are no specifically required tags for this API function to work, but you must send at least 1 of these.
\nThere are no specifically required tags for this API function to work, but you must send at least 1 of these.
\n","urlObject":{"protocol":"https","path":["ext_interface.php"],"host":["{{ZEBRA_ID}}","zebracrm","com"],"query":[{"key":"b","value":"get_multi_cards_details"}],"variable":[]}},"response":[],"_postman_id":"ab3f811c-8457-4ed0-b62e-c51ba27d8cfa"},{"name":"***Get card info - Connections","id":"65f0285d-073e-4477-9f1d-f2814cf2330a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"\r\nThis is currently not an active function
\nThis is an example of sending just fields for searching and receiving.
\nThe structure is divided into 3 types of tags
\nThe permission tags are the same as in all other ZebraCRM XMLs.\nThe Filter tags are used as the search terms with AND conditioning.\nThe Information tags are the tags of the fields ZebraCRM will return with the information of the cards found in the search.
\nThe FILTERS Top-level tag in this example includes the
The FIELDS Top-level tag in this example includes the first name (P_N) and last name (F_N) cell phone number (CELL) and email address (MAIL). These are the fields ZebraCRM will fill and send back.
There are no specifically required tags for this API function to work, but you must send at least 1 of these.
\nThere are no specifically required tags for this API function to work, but you must send at least 1 of these.
\n","urlObject":{"protocol":"https","path":["ext_interface.php"],"host":["{{ZEBRA_ID}}","zebracrm","com"],"query":[{"key":"b","value":"get_multi_cards_details"}],"variable":[]}},"response":[],"_postman_id":"65f0285d-073e-4477-9f1d-f2814cf2330a"}],"id":"577ca47f-2536-4e3a-adb9-7b098ce5ee4d","description":"By using this function you can pull and find information from ZebraCRM.\nTo simplify the process we will only give the function for finding multiple cards.
\nThe XML is divided into filtering tags and information tags.\nThe filtering tags are used to filter the relevant cards with the information you are searching for. The search is done with AND.\nThe information tags are the fields ZebraCRM will return.
\n","_postman_id":"577ca47f-2536-4e3a-adb9-7b098ce5ee4d"},{"name":"Send Information","item":[{"name":"Add New Card - General","event":[{"listen":"prerequest","script":{"id":"7b48cb6c-9379-41a5-a314-039232cde72d","exec":[""],"type":"text/javascript"}}],"id":"bcefc4ff-ef0b-4a49-be41-7d0b9d7cefb7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"This is an example for adding a new card.\nThere is only 1 main difference between adding a card and updating a card - the IDENTIFIER tag. When you add a card it will always create a new card, even if a card with the same details already exists, unless a field is defined as a \"Unique Field\" in which case a new card won't be able to be created.
The structure is very simple.
\nPERMISSION tag - AuthenticationIDENTIFIER tag - Which field should be used to identify an existing card.CARD_TYPE tag - Which card type are you trying to updateCUST_DETAILS tag - Includes all of the information to update in the card. Every tag inside this top-level tag is the KEY of a field in ZebraCRM.This is an example for a simple update to a card.
\nThe structure is very simple.
\nPERMISSION tag - AuthenticationIDENTIFIER tag - Which field should be used to identify an existing card.CARD_TYPE tag - Which card type are you trying to updateCUST_DETAILS tag - Includes all of the information to update in the card. Every tag inside this top-level tag is the KEY of a field in ZebraCRM.This is an example for a simple update to a card.
\nThe structure is very simple.
\nPERMISSION tag - AuthenticationIDENTIFIER tag - Which field should be used to identify an existing card.CARD_TYPE tag - Which card type are you trying to updateCUST_DETAILS tag - Includes all of the information to update in the card. Every tag inside this top-level tag is the KEY of a field in ZebraCRM.When sending information to a checkbox field, you need to send in the tag 1 for TRUE and 0 for FALSE.
\nIn ZebraCRM there are a number of of list field types.\nThese are the types and the expected format.
\n","urlObject":{"protocol":"https","path":["ext_interface.php"],"host":["{{ZEBRA_ID}}","zebracrm","com"],"query":[{"key":"b","value":"update_customer"}],"variable":[]}},"response":[],"_postman_id":"353b184a-3e4c-4561-8f65-ae9a5e8d073f"},{"name":"Address","event":[{"listen":"prerequest","script":{"id":"c9fb89a7-75ab-4473-be2b-78917ef8c034","exec":[""],"type":"text/javascript","packages":{}}}],"id":"5a003273-61de-42a0-8fdd-888dccf41827","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"This documentation outlines the structures and requirements for sending address information to the ZebraCRM API. Two different XML structures are supported for address submission.
\nZebraCRM supports two different XML structures for sending address information. Both structures are valid, but the new structure using ADRS_ID is recommended for new implementations.
In the legacy structure, address fields are sent directly within the CUST_DETAILS tag:
<CUST_DETAILS>\n <CITY>תל אביב</CITY>\n <STREET>דיזינגוף</STREET>\n <NUM>42</NUM>\n <ENTRANCE>B</ENTRANCE>\n <FLOOR>3</FLOOR>\n <APARTMENT_NUMBER>15</APARTMENT_NUMBER>\n <POB>7249</POB>\n <ZIP>6473107</ZIP>\n <STATE>תל אביב</STATE>\n <COUNTRY>ישראל</COUNTRY>\n <FREE_TEXT>ליד בית המרקחת</FREE_TEXT>\n</CUST_DETAILS>\n\nThe new structure requires all address fields to be wrapped within an ADRS_ID tag:
<CUST_DETAILS>\n <ADRS_ID>\n <CITY>תל אביב</CITY>\n <STREET>דיזינגוף</STREET>\n <NUM>42</NUM>\n <ENTRANCE>B</ENTRANCE>\n <FLOOR>3</FLOOR>\n <APARTMENT_NUMBER>15</APARTMENT_NUMBER>\n <POB>7249</POB>\n <ZIP>6473107</ZIP>\n <STATE>תל אביב</STATE>\n <COUNTRY>ישראל</COUNTRY>\n <FREE_TEXT>ליד בית המרקחת</FREE_TEXT>\n </ADRS_ID>\n</CUST_DETAILS>\n\nAll fields are optional unless specified otherwise by your specific implementation requirements.
\nThis is an example of updating a card including Credit Card information.
\nThe structure is very simple.
\nPERMISSION tag - AuthenticationIDENTIFIER tag - Which field should be used to identify an existing card.CARD_TYPE tag - Which card type are you trying to updateCUST_DETAILS tag - Includes all of the information to update in the card. Every tag inside this top-level tag is the KEY of a field in ZebraCRM. Please note that inside this tag there are credit card value tagPELECARD_TOKEN tag - This tag is used to send the Credit Card Token to ZebraCRM. Please note that no matter which provider you use, the tag is still PELECARD_TOKEN. Please note that in order for ZebraCRM to use the credit card, you also need to send the credit card information in the CUST_DETAILS tagAs mentioned above, there are 2 parts you need to send -
\nCUST_DETAILS tagWhen Updating a card it is possible to identify the card with multiple identifier fields.
\nThe general structure is
\nPERMISSION tag - AuthenticationIDENTIFIER tags - Which fields should be used to identify an existing card. More information in the following section.CARD_TYPE tag - Which card type are you trying to updateCUST_DETAILS tag - Includes all of the information to update in the card. Every tag inside this top-level tag is the KEY of a field in ZebraCRM.In order to have multiple fields as identifiers you will need to also add information to the following tags
\n","urlObject":{"protocol":"https","path":["ext_interface.php"],"host":["{{ZEBRA_ID}}","zebracrm","com"],"query":[{"key":"b","value":"update_customer"}],"variable":[]}},"response":[],"_postman_id":"89ffb239-68b6-4ff2-b0a7-64e544c165ff"},{"name":"Updating Sub-card","id":"8de964d0-c263-43da-a6ee-e508e8b99a88","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"\r\nWhen Updating a card it is possible to identify the card with multiple identifier fields.
\nThe general structure is
\nPERMISSION tag - AuthenticationIDENTIFIER tags - Which fields should be used to identify an existing card. More information in the following section.CARD_TYPE tag - Which card type are you trying to updateCUST_DETAILS tag - Includes all of the information to update in the card. Every tag inside this top-level tag is the KEY of a field in ZebraCRM.To connect the sub card to a parent card, you need to add the top level tag PARENT_DETAILS with the details needed for identifying the parent card.
This is an example of updating a card and adding multiple new items to a single module.
\nThe structure of this API call is divided into a few parts. In order for this API call to work, you must send all of these parts.
\nPERMISSION tag - AuthenticationIDENTIFIER tag - Which field should be used to identify an existing card.CARD_TYPE tag - Which card type are you trying to updateCUST_DETAILS tag - Includes all of the information to update the card. Every tag inside this top-level tag is the KEY of a field in ZebraCRM. Please note that even if you leave this area empty, you must send this top-level tagMODULES tag - This top-level tag can include sending information to multiple modules in one API call. This can be multiple entries to a single module or a single entry to multiple modules and of course multiple entries to multiple modules. Each entry is separated into its own MODULE tag. More information is in the following section.Modules are an essential part of using ZebraCRM for storing ongoing information about a customer. Classically a field stores information that does not change. Modules help when you wish to have ongoing information about a customer without erasing the old information.\nEach module has its own fields which store information and you can have multiple modules in every card type.\nThe use for modules changes for each system. A few examples - receiving support messages from a website, writing meeting summaries, survey answers, and many more.\nIn this XML we have an example of a module that receives support requests from a website.
\nThe specific fields of each module are different for each system. Before you start working on sending this API call, make sure you have the KEY for the Module and the module fields.
\nThe structure of the call inside the top-level MODULES tag is as follows
This is an example of updating a card and adding multiple new items to a single module.
\nThe structure of this API call is divided into a few parts. In order for this API call to work, you must send all of these parts.
\nPERMISSION tag - AuthenticationIDENTIFIER tag - Which field should be used to identify an existing card.MODULES tag - This top-level tag can include updating information to multiple items in one API call. Each entry is separated into its own MODULE tag.The specific fields of each module are different for each system. Before you start working on sending this API call, make sure you have the KEY for the Module and the module fields.
\nThe structure of the call inside the top-level MODULES tag is as follows
This is an example of updating a card and adding multiple new contacts for that card.
\nThe structure of this API call is divided into a few parts. In order for this API call to work, you must send all of these parts.
\nPERMISSION tag - AuthenticationIDENTIFIER tag - Which field should be used to identify an existing card.CARD_TYPE tag - Which card type are you trying to updateCUST_DETAILS tag - Includes all of the information to update the card. Every tag inside this top-level tag is the KEY of a field in ZebraCRM. Please note that even if you leave this area empty, you must send this top-level tagCONTACTS tag - This top-level tag is for creating new contacts under the card you are adding/updating.Contacts are sub-cards to a primary card. When sending 1 contact card, the sub-tag is <CONTACT>. But when you send multiple cards you need to send them with an index so the first contact will be in the <CONTACT1> and the second one will be in <CONTACT2> and so on.
This is an example of the structure of the XML needed to send a file to ZebraCRM.\nThe files will be sent to the archive and must in base64 format.\nYou can also send files to manual modules.
\nThe structure of this API call is divided into a few parts. In order for this API call to work, you must send all of these parts.
\nPERMISSION tag - AuthenticationIDENTIFIER tag - Which field should be used to identify an existing card.CARD_TYPE tag - Which card type are you trying to updateCUST_DETAILS tag - Includes all of the information to update the card. Every tag inside this top-level tag is the KEY of a field in ZebraCRM. Please note that even if you leave this area empty, you must send this top-level tagFILES tag - This top-level tag is for uploading new files to the card you are adding/updating.These are the tags you need to send to upload a file to a card
\n/*\ntype\nimage/gif\nimage/jpeg\nimage/jpg\nimage/png\nimage/bmp\nimage/GIF\nimage/JPEG\nimage/JPG\nimage/PNG\nimage/BMP\napplication/pdf\ntext/html\n*/
\n","urlObject":{"protocol":"https","path":["ext_interface.php"],"host":["{{ZEBRA_ID}}","zebracrm","com"],"query":[{"key":"b","value":"update_customer"}],"variable":[]}},"response":[],"_postman_id":"46a78a4b-9893-4306-a5f3-c7639844643f"},{"name":"Updating card - upload file with other details","id":"60ddbf5c-cf14-44cd-9d14-313706d70abf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"\r\nThis is an example shows an example for combining multiple types of updates in 1 XML.
\n","urlObject":{"protocol":"https","path":["ext_interface.php"],"host":["{{ZEBRA_ID}}","zebracrm","com"],"query":[{"key":"b","value":"update_customer"}],"variable":[]}},"response":[],"_postman_id":"d1d089fe-34ba-4dc8-91c8-27168bdb3d43"},{"name":"Updating card - Daycare systems","id":"1b2bf946-ec2d-4a92-9b0d-a81d9a048bef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"There are 2 types of API calls for writing to cards -
\nadd_customer- adding new cardsupdate_customer - update an existing card, if the card doesn't exist - a new card will be created.\nThere is only 1 main difference between adding a card and updating a card - the addition of the IDENTIFIER tag. When you add a card it will always create a new card, even if a card with the same details already exists, unless a field is defined as a \"Unique Field\" in which case a new card won't be able to be created.\nIn general, for most cases the update_customer call would be the only call you would need and use.These are the top level tags when sending the add_customer and update_customer API calls. This is also the structure you need to use to send these API calls.\n##
PERMISSION tag - This is the authentication tag Always requiredIDENTIFIER tag - Which field should be used to identify an existing card. This is only relevent in the update_customer call.CARD_TYPE tag - Which card type are you trying to add/update.CUST_DETAILS tag - Includes all of the information to update in the card. Every tag inside this top-level tag is the KEY of a field in ZebraCRM. Please note that inside this tag there are credit card value tag.PELECARD_TOKEN tag - This tag is used to send the Credit Card Token to ZebraCRM. Please note that no matter which provider you use, the tag is still PELECARD_TOKEN. Please note that in order for ZebraCRM to use the credit card, you also need to send the credit card information in the CUST_DETAILS tag.MODULES tag - This tag is used for adding information into a module inside a card.FILES tag - This tag is used for sending files to the files archive in a card.FOCUSES tag - This tag is used for updating the status of a focus in a card.CONTACTS tag - This tag is used to create and connect contact cards to a card. Please note that this will only work if the card type has contacts.IDENTIFIER_CONDITION_TYPE tag - Set Identifier fields as AND or OR.IDENTIFIER_CARDS_TYPES tag - This tag is used when multiple identifier fields are set to set which cards should be user for searching for the identifier information.CONNECTION_CARD_DETAILS tag - This tag is used for creating a connection between cards. Please note that this can only work if the connection exists between the card types in the ZebraCRM system you are working with.ADDITIONS tag - This tag is used to create additional cards. Please note that in order to use this tag there must be additions set for the card type in the ZebraCRM system you are working with.ADD_DOUBLE_CARDS tag - This tag is used to allow adding a new card even if a card exists with the same information in a unique field.MEONOT_SYSTEM tag - This tag is used to mark that the XML should be treated in accordance to how a ZebraCRM daycare system is set.As mentioned above, there are 2 parts you need to send -
\nCUST_DETAILS tagThese are the responses and errors you can get from this type of API call.
\n","_postman_id":"b3e00d42-b5ea-43de-9972-263c25952f34"}],"id":"289d5819-08b8-4cd6-b22d-31a744217c90","description":"Cards in the CRM contain various type of information. By using the API you can create cards and update existing information in the cards.\nThe Customer cards are mainly used as customer cards, but many of our clients use the card for other uses such as project cards, course cards and more.\nEach card type has a unique ID which is used in the API to identify where to send the information.\nIn the basic ZebraCRM setup there are 2 main customer cards - Business Customers and Private Customers. Here are the IDs for the default cards which come with the default setup of ZebraCRM
\nThe structure of every card is based on the following parts:
\nThe general details is where the basic information (such as name, ID, email etc.) about the card is stored. Please note that this includes the credit card information (Token, expiration date etc.). In many ZebraCRM setups there are many additional fields in the General details area.
\nEach ZebraCRM has it's own unique fields and therefore they have there own unique field keys. Here are some of the Keys for common fields used by our clients.
\nThe relevant fields for the ZebraCRM system you're connecting to can be found in the XML template creator in ZebraCRM settings at Advanced configuration -> Import and export leads.
\nModules are part of the information stored inside cards. In many ways Modules are structured like little and limited cards of there own.\nSome of the uses for Modules are-
\nModules have a unique ID key and multiple fields with unique ID keys.
\nIn ZebraCRM there is an option to create connection between cards. Once a connection type is created in ZebraCRM, you can connect cards through the API.
\n","_postman_id":"289d5819-08b8-4cd6-b22d-31a744217c90"},{"name":"Financial APIs","item":[{"name":"Create Financial Document","id":"0d7c7415-72a7-4e93-8115-3f72971e1073","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":" \r\nThis is an example for creating a new document in ZebraCRM.
\nThe structure of this API call is divided into a few parts.
\nPERMISSION tag - Authentication
IDENTIFIER tag - The ID of the card the document is for.
DOCUMENT tag - This tag will include all of the document information.
The structure of the call inside the top-level DOCUMENT tag is as follows
These are the possible documents and their values for the TYPE tag. Note the if the top-level or are not required then it is required for them not to be sent at all. If you send them when they are not required, you will get an error.
For documents with payments, the payment can be divided into a number of payment methods. Each Payment method would be in it's own tag with the relevant information.
\nFor documents with products, each product needs to be in it's own tag with the relevant information.
\nThese are extra fields in the document for general details in the document.
\n","urlObject":{"protocol":"https","path":["ext_interface.php"],"host":["{{ZEBRA_ID}}","zebracrm","com"],"query":[{"key":"b","value":"add_document"}],"variable":[]}},"response":[],"_postman_id":"0d7c7415-72a7-4e93-8115-3f72971e1073"},{"name":"Add subsciber","id":"cb9fe140-dc6e-4240-8e06-e6e480deba59","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"\r\nIn ZebraCRM there are 2 options for creating recurring creations of documents - Subscriptions and Standing Orders. In this documentation we will be referring to both of them as subscriptions, unless specified otherwise.
\nThe structure of this API call is divided into a few parts.
\nPERMISSION tag - AuthenticationIDENTIFIER tag - The ID of the card the document is for.SUBSCRIBER tag - This tag will include all of the subscription information.The structure of the call inside the top-level SUBSCRIBER tag is as follows
These are the possible documents and their values for the ACTION_TYPE tag. Note the if the top-level <PRODUCTS> tag is not required then it is required for it not to be sent at all.
For documents with payments, the payment can be divided into a number of payment methods. Each Payment method would be in it's own <TRANSACTION> tag with the relevant information. \n\"each_month\"\n , \"each_tow_monthes\"\n , \"each_three_monthes\"\n , \"each_four_monthes\"\n , \"each_half_year\"\n , \"each_year\"\n , \"each_tow_years\"
For documents with products, each product needs to be in it's own <PRODUCT> tag with the relevant information.
These are extra fields in the document for general details in the document.
\n","urlObject":{"protocol":"https","path":["ext_interface.php"],"host":["{{ZEBRA_ID}}","zebracrm","com"],"query":[{"key":"b","value":"add_subscriber"}],"variable":[]}},"response":[],"_postman_id":"cb9fe140-dc6e-4240-8e06-e6e480deba59"},{"name":"Add subsciber - multiple products","id":"fd9cbdee-ad0e-4e8c-99d6-8038215c634c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"https://docs.google.com/document/d/1suGs2zzUP74zO36qYRwcAf50Bh1tr8E1/edit
\nAs a CRM, producing financial documents is an important and integral part of ZebraCRM.
By using these API calls you can produce various types of documents which exist in ZebraCRM. Please note the not all documents can be produced via API.
The Identifier in Document API calls must be in the format in this example with the card ID.
\nThere are 2 API calls related to documents
\nadd_document- Creating a new document.
add_subscriber - Create a new Subscription or Standing Order.
##Document Types
In ZebraCRM there are over 20 types financial documents, but the type of documents you can create is different for each API call.
The API call add_document is limited to the following documents
Invoice Receipt
\nReceipt
\nTax Invoice
\nCredit Invoice
\nReturn Receipt
\nDonation
\nDonation with request
\nQuote
\nProforma Invoice
\nSales order
\nShipping Certificate
\nThe add_subscriber API call has 2 types of recurring document creations- Subscriptions and Standing Order.
Subscriptions are limited to only the following documents
Invoice Receipt
\nTax Invoice
\nDonation with request
\nProforma Invoice
\nStanding Order can only be the following documents
\nDonation
\nReceipt
\nSome of the documents can include an order to create a credit card payment through the credit card saved in the ZebraCRM card.
These are the documents which include payments
Invoice Receipt
\nReceipt
\nDonation
\nDonation with request
\n