Until the end of 2025, the old headers USER_AGENT and IPRESSO_TOKEN will be supported. After that, only the new headers User-Agent and Ipresso-Token will be accepted.
iPresso API is based on REST architecture. It supports GET, POST , PUT and DELETE requests.
iPresso responds with data in JSON format. The response includes field code, which specifies if the request was successful and informs about encountered errors.
Error codes are compatible with the HTTP status. The response also includes message, which contains written description of the code and data, which contains data. API discerns headers, therefore it is not possible to send requests via web browser.
\n\nIn order for the coding to be correct
\nUTF-8should be used.
\n\nThe data format passed in calls is:
\nContent-Type: application/x-www-form-urlencoded
\n\nThe current version of the iPresso API is 2.0.
\n
See the following examples:
\n\n\nParameter
\nCLIENT_PANEL_ADDRESSshould be replaced with the URL address of iPresso.
\n\nParameter
\nID_CONTACTshould be replaced with contact’s ID.
Also, when you're working on the implementation, make sure to check out the Limits and Error Codes section.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"1716599","collectionId":"725c1a26-662a-bded-faff-ff7df657030a","publishedId":"RWaDVW1e","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2018-11-02T10:07:23.000Z"},"item":[{"name":"Authentication","item":[{"name":" How to get a token","id":"f50c791d-6f8e-e2cc-66e0-49f3e360acd5","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"User-Agent","value":"iPresso"},{"key":"Authorization","value":"BasicIn order to gain temporary API key, send GET request to the url address https://CLIENT_PANEL_ADDRESS/api/2/auth/CUSTOMER_KEY. CLIENT_PANEL_ADDRESS should be replaced with your own iPresso address. CUSTOMER_KEY should be replaced with the key assigned to proper iPresso account. API user’s access data - login and password - should also be given.
Access data of API user - login and password - must also be transferred. The received Ipresso-Token will be returned in the data field.
\n\n\n
CUSTOMER_KEYshould be retrieved from iPresso's panel: System -> System accesses -> API Users -> API Users.
\n\n","urlObject":{"protocol":"https","path":["api","2","auth","CUSTOMER_KEY"],"host":["CLIENT_PANEL_ADDRESS"],"query":[],"variable":[]}},"response":[{"id":"c97c834a-9e0e-6cf0-4609-10309744a0cf","name":"Authentication - success","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"User-Agent","value":"iPresso"},{"key":"Authorization","value":"Basic\n
Ipresso-Tokenis required in each request to iPresso API. Its value should be included in the heading asIpresso-Token:HASH, where HASH is equal to the value of thedatafield.
In iPresso panel settings (System -> System accesses -> API Users -> API Users) you may set up time periods in which theIpresso-Tokenis to be valid. Additionally, you may use the option that, depending on the value selected in the settings, will return the same or a differentIpresso-Token(System -> System accesses -> API Users -> API Users).
In order to collect contact's data send GET request to the URL:https://CLIENT_PANEL_ADDRESS/api/2/contact/ID_CONTACT
\n\nThe ability to track a contact in the browser will only be possible after it has been monitored.
\n
To do this, display a tracking pixel to the contact in the browser (as an image in theIMGtag). The pixel address is returned in themonitoringPixelfield.
It is also possible to display anIFRAMEtag whose code is returned in themonitoringCodefield, or to create your ownIFRAMEcode using the address returned in themonitoringLinkfield.
\n\nAll returned data for contact monitoring is immutable and can be saved so that there is no need to re-download it. Monitoring should occur whenever possible upon each login or return to the website, as users may change browsers/devices.
\n
\n\nThe ability to track a contact in the browser will only be possible after it has been monitored.
\n
\n\nTo do this, use the setContactId method https://js-api-doc.ipresso.pl/methods/identification/set-contact-id
\n
\n\nThis method should be passed the value returned in the
\nhashIdContactfield as a parameter.
\n\nAll returned contact tracking data is immutable and can be saved, eliminating the need to re-download it. Tracking should occur whenever possible upon each login or return to the website, as users may change browsers or devices.
\n
\n\n","urlObject":{"protocol":"https","path":["api","2","contact","ID_CONTACT"],"host":["CLIENT_PANEL_ADDRESS"],"query":[],"variable":[]}},"response":[{"id":"64ddbd49-410a-27c5-360c-6a9446824e79","name":"Success","originalRequest":{"method":"GET","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"}],"body":{"mode":"formdata","formdata":[]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/contact/ID_CONTACT"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Encoding","value":"gzip","description":""},{"key":"Content-Length","value":"821","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Thu, 05 Oct 2017 08:49:39 GMT","description":""},{"key":"Vary","value":"Accept-Encoding","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"5ru4jlnfi6pmao3os1q84vnc45","key":"PHPSESSID"}],"responseTime":"498","body":"{\n \"code\": 200,\n \"data\": {\n \"contact\": {\n \"idContact\": 154,\n \"fname\": \"Fname\",\n \"lname\": \"Lname\",\n \"vocative\": \"\",\n \"name\": \"\",\n \"email\": \"test@ipresso.com\",\n \"invalidEmail\": \"0\",\n \"phone\": \"\",\n \"mobile\": \"123456789\",\n \"postCode\": false,\n \"street\": false,\n \"buildingNumber\": false,\n \"flatNumber\": false,\n \"city\": false,\n \"country\": false,\n \"www\": false,\n \"workPosition\": \"\",\n \"company\": false,\n \"createDate\": \"2018-10-12 09:28:35\",\n \"modifyTime\": false,\n \"leadScoring\": \"0\",\n \"type\": false,\n \"agreement\": {\n \"1\": \"I agree to receive marketing information\"\n },\n \"category\": [],\n \"tag\": [],\n \"contactMonitoringIframe\": \"\",\n \"monitoringLink\": \"https://CLIENT_PANEL_ADDRESS/contactcookie/6m3dzoqpr8JENviKTJCMdxJXicwrC8iWusoQFeGBL0I./dfe5db49db65273ca4daa73e1ecb8cac\",\n \"monitoringPixel\": \"https://CLIENT_PANEL_ADDRESS/systemnc/contactcookiepixel/6m3dzoqpr8JENviKTJCMdxJXicwrC8iWusoQFeGBL0I./dfe5db49db65273ca4daa73e1ecb8cac.png\",\n \"hashIdContact\": \"6m3dzoqpr8JENviKTJCMdxJXicwrC8iWusoQFeGBL0I.\",\n \"profilePageUrl\": {\n \"1\": \"https://CLIENT_PANEL_ADDRESS/contact/profile/show/ckd4M1JNVUFwejJJYUFzS0F0V1BEdz09/6m3dzoqpr8JENviKTJCMdxJXicwrC8iWusoQFeGBL0I.\",\n \"2\": \"https://CLIENT_PANEL_ADDRESS/contact/profile/show/WmluWjRQbjg0bEI1dFVFMkNCNGpOZz09/6m3dzoqpr8JENviKTJCMdxJXicwrC8iWusoQFeGBL0I.\"\n }\n }\n },\n \"message\": \"OK\"\n}"},{"id":"ae48f8c4-5d9d-8e18-c2ee-0523abf52fdf","name":"Error-Not Found","originalRequest":{"method":"GET","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"}],"url":"https://CLIENT_PANEL_ADDRESS/api/2/contact/ID_CONTACT"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Encoding","value":"gzip","description":""},{"key":"Content-Length","value":"83","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Thu, 05 Oct 2017 08:50:55 GMT","description":""},{"key":"Vary","value":"Accept-Encoding","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"5ru4jlnfi6pmao3os1q84vnc45","key":"PHPSESSID"}],"responseTime":"183","body":"{\"code\":404,\"message\":\"Not valid idContact - Not Found\",\"errorCode\":44}"}],"_postman_id":"e3b7f9c4-54f7-28c3-b0f9-74d5bdeaf5d5"},{"name":"Collecting tags for a contact","id":"2b80736c-0668-ad28-aae3-c2175bcd385c","request":{"method":"GET","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"data[tag][0]","value":"02.10.2017_Wojtek_wysylkamailiWW_TAK"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/contact/ID_CONTACT/tag","description":"Method that retrieves a contact returns static attributes (described in the table) and all the dynamic attributes (created by client) along with values ascribed to a contact.
\n
In order to collect contact's tags you should send GET request to the URL:\n https://CLIENT_PANEL_ADDRESS/api/2/contact/ID_CONTACT/tag
In order to get available activities of a given contact send GET request to the URL: https://CLIENT_PANEL_ADDRESS/api/2/contact/ID_CONTACT/activity/
In the case of getting large number of activities assigned to a contact, the system will respond with just the first page of 50 records. In order to see other pages it is necessary to define which page is to be displayed by adding parameter ?page=N where N corresponds to the number of the page: https://CLIENT_PANEL_ADDRESS/api/2/contact/ID_CONTACT/activity?page=2
Meaning of the returned id_connection parameter for specific activities:
In order to get contact’s activities send GET request to the URL: https://CLIENT_PANEL_ADDRESS/api/2/contact/ID_CONTACT/action
In the case of getting large number of activities assigned to a contact, the system will respond with just the first page of 50 records. In order to see other pages it is necessary to define which page is to be displayed by adding parameter ?page=N where N corresponds to the number of the page, e.g.: https://CLIENT_PANEL_ADDRESS/api/2/contact/ID_CONTACT/action?page=2
Meaning of the returned id_connection parameter for specific actions:
In order to get a category for a contact send GET request to the URL: https://CLIENT_PANEL_ADDRESS/api/2/contact/ID_CONTACT/category
In order to get contacts integration send GET request to the URL: https://CLIENT_PANEL_ADDRESS/api/2/contact/ID_CONTACT/integration
In order to get contact’s consents send GET request to the URL: https://CLIENT_PANEL_ADDRESS/api/2/contact/ID_CONTACT/agreement/
The changeDates section will be deprecated in the future; all consent details can be found in the consents field .
In order to get contact’s consents in group send GET request to the URL: https://CLIENT_PANEL_ADDRESS/api/2/contact/ID_CONTACT/agreement/group/API_GROUP_KEY
\n\nParameter
\nAPI_GROUP_KEYshould be replaced with api key of a chosen consent group.
\n\nParameter
\nID_CONTACTshould be replaced with contact ID number.
The changeDates section will be deprecated in the future; all consent details can be found in the consents field.
In order to get connections between contacts send GET request to the URL: https://CLIENT_PANEL_ADDRESS/api/2/contact/ID_CONTACT/connection
In order to get contact attributes send GET request to the URL: https://CLIENT_PANEL_ADDRESS/api/2/contact/ID_CONTACT/attribute
In order to get contact’s type send GET request to the URL: https://CLIENT_PANEL_ADRESS/api/2/contact/ID_CONTACT/type
In order to get contact profile pages send GET request to the URL: https://CLIENT_PANEL_ADDRESS/api/2/contact/ID_CONTACT/profilepage
In order to decode the contact's hash ID, send a GET request to the following URL: https://CLIENT_PANEL_ADDRESS/api/2/contact/longName/hash.
\n\n","urlObject":{"protocol":"https","path":["api","2","contact","longName","hash"],"host":["CLIENT_PANEL_ADDRESS"],"query":[],"variable":[]}},"response":[{"id":"9947fd90-ca0a-4234-b53a-cd4ba83f1186","name":"Success","originalRequest":{"method":"GET","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"url":"https://CLIENT_PANEL_ADDRESS/api/2/contact/longName/hash"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"56","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Fri, 06 Oct 2017 09:21:49 GMT","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"l00ihorbl4lbstskjv8tk92og4","key":"PHPSESSID"}],"responseTime":null,"body":"{\"code\":200,\"data\":{\"id_contact\":306157},\"message\":\"OK\"}"},{"id":"d72b6304-7d5f-4e96-801c-aa76414fabf8","name":"Error","originalRequest":{"method":"GET","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"url":"https://CLIENT_PANEL_ADDRESS/api/2/contact/longName/hash"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Encoding","value":"gzip","description":""},{"key":"Content-Length","value":"95","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Fri, 06 Oct 2017 09:23:13 GMT","description":""},{"key":"Vary","value":"Accept-Encoding","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"l00ihorbl4lbstskjv8tk92og4","key":"PHPSESSID"}],"responseTime":null,"body":"{\"code\":400,\"message\":\"B\\u0142\\u0105d w trakcie dekodowania hasha\",\"errorCode\":78}"}],"_postman_id":"ebe34582-304c-4137-a302-f1d1d880dc3e"},{"name":"Edition of a contact with a given ID number","id":"202c606c-dbfe-57cd-2c2c-9749ada93e63","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"contact[type]","value":"ContactType","description":"The
\nlongNameparameter should be replaced with a monitored contact's hash ID.
Contact type api key
\n"},{"key":"contact[fname]","value":"FirstName","description":"First name
\n"},{"key":"contact[lname]","value":"LastName","description":"Last name
\n"},{"key":"contact[name]","value":"OwnName","description":"Own name
\n"},{"key":"contact[email]","value":"test@ipresso.com","description":"Landline phone number
\n"},{"key":"contact[mobile]","value":"321321321","description":"Mobile phone number
\n"},{"key":"contact[company]","value":"CompanyName","description":"Name of company
\n"},{"key":"contact[city]","value":"Warsaw","description":"City
\n"},{"key":"contact[postCode]","value":"00-001","description":"Post code
\n"},{"key":"contact[street]","value":"streetName","description":"Street name
\n"},{"key":"contact[buildingNumber]","value":"1","description":"Building number
\n"},{"key":"contact[flatNumber]","value":"2","description":"Flat number
\n"},{"key":"contact[country]","value":"Poland","description":"Country
\n"},{"key":"contact[0][region]","value":"Province","description":"Province
\n","type":"text"},{"key":"contact[agreement][1]","value":"1","description":"Associative array with a pair - consent IDs or API key => consent status, where 1 = add consent, 2 = delete consent
\n"},{"key":"contact[tag][0]","value":"tag1","description":"One-dimensional array containing tag
\n"},{"key":"contact[category][1]","value":"1","description":"Associative array with a pair - category ID => category status, where 1 = add category, 2 = delete category
\n"},{"key":"contact[category][3]","value":"1","description":"Associative array with a pair - category ID => category status, where 1 = add category, 2 = delete category
\n"},{"key":"contact[dynamicAttributeString]","value":"string","description":"String dynamic attribute with the dynamicAttributeString key
\n"},{"key":"contact[dynamicAttributeInt]","value":"1","description":"Dynamic attribute of type Int with the key dynamicAttributeInt
\n"},{"key":"contact[dynamicAttributecheckbox]","value":"1","description":"Dynamic attribute of type Bool (checkbox true / false) with the key dynamicAttributecheckbox
\n"},{"key":"contact[dynamicAttributeSelect]","value":"selectOption1","description":"Dynamic attribute of type Select (one of many) with the key dynamicAttributeSelect
\n"},{"key":"contact[dynamicAttributeMultiselect][0]","value":"multiselectOption1","description":"Dynamic attribute of the Multiselect type (many of many) with the dynamicAttributeMultiselect key
\n"},{"key":"contact[dynamicAttributeMultiselect][1]","value":"multiselectOption2","description":"Dynamic attribute of the Multiselect type (many of many) with the dynamicAttributeMultiselect key
\n"},{"key":"contact[dynamicAttributeText]","value":"text","description":"Dynamic attribute of the Text type with the dynamicAttributeText key
\n"},{"key":"contact[dynamicAttributeDate]","value":"2017-01-01","description":"Dynamic attribute of the Date type (YYYY-MM-DD) with the dynamicAttributeDate key
\n"},{"key":"contact[dynamicAttributeDateTime]","value":"2017-01-01 00:00","description":"Dynamic attribute type Date and Time (YYYY-MM-DD HH: MM) with the dynamicAttributeDateTime key
\n"},{"key":"contact[dynamicAttributeTime]","value":"00:00","description":"Dynamic attribute of Time type (HH: MM) with the dynamicAttributeTime key
\n"},{"key":"contact[facebook][id]","value":"1","description":"Facebook ID
\n"},{"key":"contact[facebook][name]","value":"User Name","description":"User name
\n"},{"key":"contact[facebook][first_name]","value":"FirstName","description":"First name
\n"},{"key":"contact[facebook][last_name]","value":"LastName","description":"Last name
\n"},{"key":"contact[source][utm_campaign]","value":"utm_campaign_test","description":"UTM campaign name
\n"},{"key":"contact[source][utm_content]","value":"utm_content_test ","description":"UTM campaign content
\n"},{"key":"contact[source][utm_medium]","value":"utm_medium_test","description":"UTM campaign medium
\n"},{"key":"contact[source][utm_source]","value":"utm_source_test","description":"UTM campaign source
\n"},{"key":"contact[source][utm_term]","value":"utm_source_test","description":"UTM campaign source
\n"},{"key":"contact[0][consents][apiKey]","value":"api_key_test","description":"Consent Api Key
\n","type":"text","uuid":"afd64e74-eeb6-4d36-b846-fa1bb01f48a7"},{"key":"contact[0][consents][consentGiven]","value":"1","description":"Information on whether consent is granted: true for granted, false for not granted.
\n","type":"text","uuid":"a8ab003a-1873-472d-8730-a30c770e892d"},{"key":"contact[0][consents][externalSource]","value":"external_source_test","description":"Information about the consent source. This is an optional parameter that allows specifying where the consent was obtained or revoked.
\n","type":"text","uuid":"d7d1563b-bf5d-41c2-82f8-814ec31523fb"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/contact/ID_CONTACT","description":"In order to edit contact’s data send PUT request to the URL:https://CLIENT_PANEL_ADDRESS/api/2/contact/ID_CONTACT. Edition allows for sending the same fields as in the case of adding new contacts.
\n\nIn order to clear field for a given contact, enter
\nAPI_NULLas its content. Only the fields with specified value are changed, e.g. string type field has to he different than „“
Editing a contact by the iPresso API allows you to edit only one contact.
\n\n\n","urlObject":{"protocol":"https","path":["api","2","contact","ID_CONTACT"],"host":["CLIENT_PANEL_ADDRESS"],"query":[],"variable":[]}},"response":[{"id":"535a354b-dddb-8918-af7c-2fe397a35692","name":"Success","originalRequest":{"method":"PUT","header":[{"key":"ACCEPT","value":"application/x-www-form-urlencoded","disabled":true},{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Authorization","value":"Basic YXBpOmFwaS5BUEkuMTIp","disabled":true}],"body":{"mode":"urlencoded","urlencoded":[{"key":"contact[type]","value":"ContactType","description":"Klucz typu kontaktu"},{"key":"contact[fname]","value":"FirstName","description":"Imię"},{"key":"contact[lname]","value":"LastName","description":"Nazwisko"},{"key":"contact[name]","value":"OwnName","description":"Nazwa własna"},{"key":"contact[email]","value":"test@ipresso.com","description":"Adres e-mail"},{"key":"contact[phone]","value":"123123123","description":"Numer telefou stacjonarnego"},{"key":"contact[mobile]","value":"321321321","description":"Numer telefonu komórkowego"},{"key":"contact[company]","value":"CompanyName","description":"Nazwa firmy"},{"key":"contact[city]","value":"Warsaw","description":"Miasto"},{"key":"contact[postCode]","value":"00-001","description":"Kod pocztowy"},{"key":"contact[street]","value":"streetName","description":"Nazwa ulicy"},{"key":"contact[buildingNumber]","value":"1","description":"Numer budynku"},{"key":"contact[flatNumber]","value":"2","description":"Numer mieszkania"},{"key":"contact[country]","value":"Poland","description":"Kraj"},{"key":"contact[agreement][1]","value":"1","description":"Zgoda marketingowa o id:1"},{"key":"contact[tag][0]","value":"tag1","description":"Tablica jednowymiarowa zawierająca tagi"},{"key":"contact[category][1]","value":"1","description":"Tablica asocjacyjna z parą identyfikator kategorii => status kategorii"},{"key":"contact[category][3]","value":"1","description":"Tablica asocjacyjna z parą identyfikator kategorii => status kategorii"},{"key":"contact[dynamicAttributeString]","value":"string","description":"Atrybut dynamiczny typu String o kluczu dynamicAttributeString"},{"key":"contact[dynamicAttributeInt]","value":"1","description":"Atrybut dynamiczny typu Int o kluczu dynamicAttributeInt"},{"key":"contact[dynamicAttributecheckbox]","value":"1","description":"Atrybut dynamiczny typu Bool (checkbox true/false) o kluczu dynamicAttributecheckbox"},{"key":"contact[dynamicAttributeSelect]","value":"selectOption1","description":"Atrybut dynamiczny typu Select (jeden z wielu) o kluczu dynamicAttributeSelect"},{"key":"contact[dynamicAttributeMultiselect][0]","value":"multiselectOption1","description":"Atrybut dynamiczny typu Multiselect (wiele z wielu) o kluczu dynamicAttributeMultiselect"},{"key":"contact[dynamicAttributeMultiselect][1]","value":"multiselectOption2","description":"Atrybut dynamiczny typu Multiselect (wiele z wielu) o kluczu dynamicAttributeMultiselect"},{"key":"contact[dynamicAttributeText]","value":"text","description":"Atrybut dynamiczny typu Text o kluczu dynamicAttributeText"},{"key":"contact[dynamicAttributeDate]","value":"2017-01-01","description":"Atrybut dynamiczny typu Date (YYYY-MM-DD) o kluczu dynamicAttributeDate"},{"key":"contact[dynamicAttributeDateTime]","value":"2017-01-01 00:00","description":"Atrybut dynamiczny typu Date and Time (YYYY-MM-DD HH:MM) o kluczu dynamicAttributeDateTime"},{"key":"contact[dynamicAttributeTime]","value":"00:00","description":"Atrybut dynamiczny typu Time (HH:MM) o kluczu dynamicAttributeTime","type":"text"},{"key":"contact[facebook][id]","value":"1","description":"Facebook ID"},{"key":"contact[facebook][name]","value":"User Name","description":"Nazwa użytkownika"},{"key":"contact[facebook][first_name]","value":"FirstName","description":"Imię"},{"key":"contact[facebook][last_name]","value":"LastName","description":"Nazwisko"},{"key":"contact[source][utm_campaign]","value":"utm_campaign_test","description":"Nazwa kampanii UTM"},{"key":"contact[source][utm_content]","value":"utm_content_test\t","description":"Treść kampanii UTM"},{"key":"contact[source][utm_medium]","value":"utm_medium_test","description":"Medium kampanii UTM"},{"key":"contact[source][utm_source]","value":"utm_source_test","description":"Źródło kampanii UTM"},{"key":"contact[source][utm_term]","value":"utm_source_test","description":"Hasło kampanii UTM"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/contact/ID_CONTACT"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"content-length","value":"44","description":"The length of the response body in octets (8-bit bytes)"},{"key":"content-type","value":"text/json;charset=UTF-8","description":"The mime type of this content"},{"key":"date","value":"Fri, 29 Sep 2017 05:52:26 GMT","description":"The date and time that the message was sent"},{"key":"x-content-type-options","value":"nosniff","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"}],"cookie":[],"responseTime":"241","body":"{\"code\":201,\"data\":true,\"message\":\"Created\"}"},{"id":"4e18c49c-a361-9c31-f6c1-9298ef50a646","name":"Not Found","originalRequest":{"method":"PUT","header":[{"key":"ACCEPT","value":"application/x-www-form-urlencoded","disabled":true},{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Authorization","value":"Basic YXBpOmFwaS5BUEkuMTIz","disabled":true}],"body":{"mode":"urlencoded","urlencoded":[{"key":"contact[type]","value":"ContactType","description":"Klucz typu kontaktu"},{"key":"contact[fname]","value":"FirstName","description":"Imię"},{"key":"contact[lname]","value":"LastName","description":"Nazwisko"},{"key":"contact[name]","value":"OwnName","description":"Nazwa własna"},{"key":"contact[email]","value":"test@ipresso.com","description":"Adres e-mail"},{"key":"contact[phone]","value":"123123123","description":"Numer telefou stacjonarnego"},{"key":"contact[mobile]","value":"321321321","description":"Numer telefonu komórkowego"},{"key":"contact[company]","value":"CompanyName","description":"Nazwa firmy"},{"key":"contact[city]","value":"Warsaw","description":"Miasto"},{"key":"contact[postCode]","value":"00-001","description":"Kod pocztowy"},{"key":"contact[street]","value":"streetName","description":"Nazwa ulicy"},{"key":"contact[buildingNumber]","value":"1","description":"Numer budynku"},{"key":"contact[flatNumber]","value":"2","description":"Numer mieszkania"},{"key":"contact[country]","value":"Poland","description":"Kraj"},{"key":"contact[agreement][1]","value":"1","description":"Zgoda marketingowa o id:1"},{"key":"contact[tag][0]","value":"tag1","description":"Tablica jednowymiarowa zawierająca tagi"},{"key":"contact[category][1]","value":"1","description":"Tablica asocjacyjna z parą identyfikator kategorii => status kategorii"},{"key":"contact[category][3]","value":"1","description":"Tablica asocjacyjna z parą identyfikator kategorii => status kategorii"},{"key":"contact[dynamicAttributeString]","value":"string","description":"Atrybut dynamiczny typu String o kluczu dynamicAttributeString"},{"key":"contact[dynamicAttributeInt]","value":"1","description":"Atrybut dynamiczny typu Int o kluczu dynamicAttributeInt"},{"key":"contact[dynamicAttributecheckbox]","value":"1","description":"Atrybut dynamiczny typu Bool (checkbox true/false) o kluczu dynamicAttributecheckbox"},{"key":"contact[dynamicAttributeSelect]","value":"selectOption1","description":"Atrybut dynamiczny typu Select (jeden z wielu) o kluczu dynamicAttributeSelect"},{"key":"contact[dynamicAttributeMultiselect][0]","value":"multiselectOption1","description":"Atrybut dynamiczny typu Multiselect (wiele z wielu) o kluczu dynamicAttributeMultiselect"},{"key":"contact[dynamicAttributeMultiselect][1]","value":"multiselectOption2","description":"Atrybut dynamiczny typu Multiselect (wiele z wielu) o kluczu dynamicAttributeMultiselect"},{"key":"contact[dynamicAttributeText]","value":"text","description":"Atrybut dynamiczny typu Text o kluczu dynamicAttributeText"},{"key":"contact[dynamicAttributeDate]","value":"2017-01-01","description":"Atrybut dynamiczny typu Date (YYYY-MM-DD) o kluczu dynamicAttributeDate"},{"key":"contact[dynamicAttributeDateTime]","value":"2017-01-01 00:00","description":"Atrybut dynamiczny typu Date and Time (YYYY-MM-DD HH:MM) o kluczu dynamicAttributeDateTime"},{"key":"contact[dynamicAttributeTime]","value":"00:00","description":"Atrybut dynamiczny typu Time (HH:MM) o kluczu dynamicAttributeTime"},{"key":"contact[facebook][id]","value":"1","description":"Facebook ID"},{"key":"contact[facebook][name]","value":"User Name","description":"Nazwa użytkownika"},{"key":"contact[facebook][first_name]","value":"FirstName","description":"Imię"},{"key":"contact[facebook][last_name]","value":"LastName","description":"Nazwisko"},{"key":"contact[source][utm_campaign]","value":"utm_campaign_test","description":"Nazwa kampanii UTM"},{"key":"contact[source][utm_content]","value":"utm_content_test\t","description":"Treść kampanii UTM"},{"key":"contact[source][utm_medium]","value":"utm_medium_test","description":"Medium kampanii UTM"},{"key":"contact[source][utm_source]","value":"utm_source_test","description":"Źródło kampanii UTM"},{"key":"contact[source][utm_term]","value":"utm_source_test","description":"Hasło kampanii UTM"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/contact/ID_CONTACT"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"content-length","value":"49","description":"The length of the response body in octets (8-bit bytes)"},{"key":"content-type","value":"text/json;charset=UTF-8","description":"The mime type of this content"},{"key":"date","value":"Fri, 29 Sep 2017 06:05:55 GMT","description":"The date and time that the message was sent"},{"key":"x-content-type-options","value":"nosniff","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"}],"cookie":[],"responseTime":"143","body":"{\"code\":404,\"message\":\"Not Found\",\"errorCode\":44}"}],"_postman_id":"202c606c-dbfe-57cd-2c2c-9749ada93e63"},{"name":"Bulk contact editing","id":"4eccf875-4fcf-4348-ad95-9825d19cd17f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"contact[2000][type]","value":"ContactType","type":"text","description":"When sending contact attributes, e.g.
\ncityorcityattribute, the allowed characters are: letters, numbers, spaces and special characters: - _ & ( ) [ ]
Using other characters will cause the request to fail.
Contact type api key
\n"},{"key":"contact[2000][fname]","value":"FirstName","type":"text","description":"First name
\n"},{"key":"contact[2000][lname]","value":"LastName","type":"text","description":"Last name
\n"},{"key":"contact[2000][name]","value":"OwnName","type":"text","description":"Own name
\n"},{"key":"contact[2000][email]","value":"test@ipresso.com","type":"text","description":"Landline phone number
\n"},{"key":"contact[2000][mobile]","value":"321321321","type":"text","description":"Mobile phone number
\n"},{"key":"contact[2000][company]","value":"CompanyName","type":"text","description":"Name of company
\n"},{"key":"contact[2000][city]","value":"Warsaw","type":"text","description":"City
\n"},{"key":"contact[2000][postCode]","value":"00-001","type":"text","description":"Post code
\n"},{"key":"contact[2000][street]","value":"streetName","type":"text","description":"Street name
\n"},{"key":"contact[2000][buildingNumber]","value":"1","type":"text","description":"Building number
\n"},{"key":"contact[2000][flatNumber]","value":"2","type":"text","description":"Flat number
\n"},{"key":"contact[2000][country]","value":"Poland","type":"text","description":"Country
\n"},{"key":"contact[2000][region]","value":"Province","type":"text","description":"Province
\n"},{"key":"contact[2000][agreement][1]","value":"1","type":"text","description":"Associative array with a pair - consent IDs or API key => consent status, where 1 = add consent, 2 = delete consent
\n"},{"key":"contact[2000][tag][0]","value":"tag1","type":"text","description":"One-dimensional array containing tag
\n"},{"key":"contact[2000][category][1]","value":"1","type":"text","description":"Associative array with a pair - category ID => category status, where 1 = add category, 2 = delete category
\n"},{"key":"contact[2000][category][3]","value":"1","type":"text","description":"Associative array with a pair - category ID => category status, where 1 = add category, 2 = delete category
\n"},{"key":"contact[2000][dynamicAttributeString]","value":"string","type":"text","description":"String dynamic attribute with the dynamicAttributeString key
\n"},{"key":"contact[2000][dynamicAttributeInt]","value":"1","type":"text","description":"Dynamic attribute of type Int with the key dynamicAttributeInt
\n"},{"key":"contact[2000][dynamicAttributecheckbox]","value":"1","type":"text","description":"Dynamic attribute of type Bool (checkbox true / false) with the key dynamicAttributecheckbox
\n"},{"key":"contact[2000][dynamicAttributeSelect]","value":"selectOption1","type":"text","description":"Dynamic attribute of type Select (one of many) with the key dynamicAttributeSelect
\n"},{"key":"contact[2000][dynamicAttributeMultiselect][0]","value":"multiselectOption1","type":"text","description":"Dynamic attribute of the Multiselect type (many of many) with the dynamicAttributeMultiselect key
\n"},{"key":"contact[2000][dynamicAttributeMultiselect][1]","value":"multiselectOption2","type":"text","description":"Dynamic attribute of the Multiselect type (many of many) with the dynamicAttributeMultiselect key
\n"},{"key":"contact[2000][dynamicAttributeText]","value":"text","type":"text","description":"Dynamic attribute of the Text type with the dynamicAttributeText key
\n"},{"key":"contact[2000][dynamicAttributeDate]","value":"2017-01-01","type":"text","description":"Dynamic attribute of the Date type (YYYY-MM-DD) with the dynamicAttributeDate key
\n"},{"key":"contact[2000][dynamicAttributeDateTime]","value":"2017-01-01 00:00","type":"text","description":"Dynamic attribute type Date and Time (YYYY-MM-DD HH: MM) with the dynamicAttributeDateTime key
\n"},{"key":"contact[2000][dynamicAttributeTime]","value":"00:00","type":"text","description":"Dynamic attribute of Time type (HH: MM) with the dynamicAttributeTime key
\n"},{"key":"contact[2000][facebook][id]","value":"1","type":"text","description":"Facebook ID
\n"},{"key":"contact[2000][facebook][name]","value":"User Name","type":"text","description":"User name
\n"},{"key":"contact[2000][facebook][first_name]","value":"FirstName","type":"text","description":"First name
\n"},{"key":"contact[2000][facebook][last_name]","value":"LastName","type":"text","description":"Last name
\n"},{"key":"contact[2000][source][utm_campaign]","value":"utm_campaign_test","type":"text","description":"UTM campaign name
\n"},{"key":"contact[2000][source][utm_content]","value":"utm_content_test\t","type":"text","description":"UTM campaign content
\n"},{"key":"contact[2000][source][utm_medium]","value":"utm_medium_test","type":"text","description":"UTM campaign medium
\n"},{"key":"contact[2000][source][utm_source]","value":"utm_source_test","type":"text","description":"UTM campaign source
\n"},{"key":"contact[2000][source][utm_term]","value":"utm_source_test","type":"text","description":"Hasło kampanii UTM
\n"},{"key":"contact[2000][consents][apiKey]","value":"api_key_test","type":"text","description":"Consent Api Key
\n"},{"key":"contact[2000][consents][consentGiven]","value":"1","type":"text","description":"Information on whether consent is granted: true for granted, false for not granted.
\n"},{"key":"contact[2000][consents][externalSource]","value":"external_source_test","type":"text","description":"Information about the consent source. This is an optional parameter that allows specifying where the consent was obtained or revoked.
\n"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/contact/","description":"In order to edit contact’s data send PUT request to the URL:https://CLIENT_PANEL_ADDRESS/api/2/contact/ID_CONTACT. Edition allows for sending the same fields as in the case of adding new contacts.
\n\nIn order to clear field for a given contact, enter
\nAPI_NULLas its content. Only the fields with specified value are changed, e.g. string type field has to he different than „“
Keys must be constructed according to the following pattern:
\ncontact[{contact_id}][{field}]
{contact_id} – The unique identifier of the contact in the database (e.g., 2000).
{field} – The name of the field you want to update (e.g., fname, lname, email).
\n\n","urlObject":{"protocol":"https","path":["api","2","contact",""],"host":["CLIENT_PANEL_ADDRESS"],"query":[],"variable":[]}},"response":[{"id":"4190ea41-c20f-4c3e-9786-9927e2fd4e04","name":"Success","originalRequest":{"method":"PUT","header":[{"key":"ACCEPT","value":"application/x-www-form-urlencoded","disabled":true},{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Authorization","value":"{{vault:basic-auth}}","disabled":true}],"body":{"mode":"urlencoded","urlencoded":[{"key":"contact[2000][type]","value":"ContactType","type":"text","description":"Klucz typu kontaktu"},{"key":"contact[2000][fname]","value":"FirstName","type":"text","description":"Imię"},{"key":"contact[2000][lname]","value":"LastName","type":"text","description":"Nazwisko"},{"key":"contact[2000][name]","value":"OwnName","type":"text","description":"Nazwa własna"},{"key":"contact[2000][email]","value":"test@ipresso.com","type":"text","description":"Adres e-mail"},{"key":"contact[2000][phone]","value":"123123123","type":"text","description":"Numer telefou stacjonarnego"},{"key":"contact[2000][mobile]","value":"321321321","type":"text","description":"Numer telefonu komórkowego"},{"key":"contact[2000][company]","value":"CompanyName","type":"text","description":"Nazwa firmy"},{"key":"contact[2000][city]","value":"Warsaw","type":"text","description":"Miasto"},{"key":"contact[2000][postCode]","value":"00-001","type":"text","description":"Kod pocztowy"},{"key":"contact[2000][street]","value":"streetName","type":"text","description":"Nazwa ulicy"},{"key":"contact[2000][buildingNumber]","value":"1","type":"text","description":"Numer budynku"},{"key":"contact[2000][flatNumber]","value":"2","type":"text","description":"Numer mieszkania"},{"key":"contact[2000][country]","value":"Poland","type":"text","description":"Kraj"},{"key":"contact[2000][region]","value":"Province","type":"text","description":"Zgoda marketingowa o id:1"},{"key":"contact[2000][agreement][1]","value":"1","type":"text","description":"Tablica jednowymiarowa zawierająca tagi"},{"key":"contact[2000][tag][0]","value":"tag1","type":"text","description":"Tablica asocjacyjna z parą identyfikator kategorii => status kategorii"},{"key":"contact[2000][category][1]","value":"1","type":"text","description":"Tablica asocjacyjna z parą identyfikator kategorii => status kategorii"},{"key":"contact[2000][category][3]","value":"1","type":"text","description":"Atrybut dynamiczny typu String o kluczu dynamicAttributeString"},{"key":"contact[2000][dynamicAttributeString]","value":"string","type":"text","description":"Atrybut dynamiczny typu Int o kluczu dynamicAttributeInt"},{"key":"contact[2000][dynamicAttributeInt]","value":"1","type":"text","description":"Atrybut dynamiczny typu Bool (checkbox true/false) o kluczu dynamicAttributecheckbox"},{"key":"contact[2000][dynamicAttributecheckbox]","value":"1","type":"text","description":"Atrybut dynamiczny typu Select (jeden z wielu) o kluczu dynamicAttributeSelect"},{"key":"contact[2000][dynamicAttributeSelect]","value":"selectOption1","type":"text","description":"Atrybut dynamiczny typu Multiselect (wiele z wielu) o kluczu dynamicAttributeMultiselect"},{"key":"contact[2000][dynamicAttributeMultiselect][0]","value":"multiselectOption1","type":"text","description":"Atrybut dynamiczny typu Multiselect (wiele z wielu) o kluczu dynamicAttributeMultiselect"},{"key":"contact[2000][dynamicAttributeMultiselect][1]","value":"multiselectOption2","type":"text","description":"Atrybut dynamiczny typu Text o kluczu dynamicAttributeText"},{"key":"contact[2000][dynamicAttributeText]","value":"text","type":"text","description":"Atrybut dynamiczny typu Date (YYYY-MM-DD) o kluczu dynamicAttributeDate"},{"key":"contact[2000][dynamicAttributeDate]","value":"2017-01-01","type":"text","description":"Atrybut dynamiczny typu Date and Time (YYYY-MM-DD HH:MM) o kluczu dynamicAttributeDateTime"},{"key":"contact[2000][dynamicAttributeDateTime]","value":"2017-01-01 00:00","type":"text","description":"Atrybut dynamiczny typu Time (HH:MM) o kluczu dynamicAttributeTime"},{"key":"contact[2000][dynamicAttributeTime]","value":"00:00","type":"text","description":"Facebook ID"},{"key":"contact[2000][facebook][id]","value":"1","type":"text","description":"Nazwa użytkownika"},{"key":"contact[2000][facebook][name]","value":"User Name","type":"text","description":"Imię"},{"key":"contact[2000][facebook][first_name]","value":"FirstName","type":"text","description":"Nazwisko"},{"key":"contact[2000][facebook][last_name]","value":"LastName","type":"text","description":"Nazwa kampanii UTM"},{"key":"contact[2000][source][utm_campaign]","value":"utm_campaign_test","type":"text","description":"Treść kampanii UTM"},{"key":"contact[2000][source][utm_content]","value":"utm_content_test\t","type":"text","description":"Medium kampanii UTM"},{"key":"contact[2000][source][utm_medium]","value":"utm_medium_test","type":"text","description":"Źródło kampanii UTM"},{"key":"contact[2000][source][utm_source]","value":"utm_source_test","type":"text","description":"Hasło kampanii UTM"},{"key":"contact[2000][source][utm_term]","value":"utm_source_test","type":"text"},{"key":"contact[2000][consents][apiKey]","value":"api_key_test","type":"text"},{"key":"contact[2000][consents][consentGiven]","value":"1","type":"text"},{"key":"contact[2000][consents][externalSource]","value":"external_source_test","type":"text"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/contact/"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"content-length","value":"44","description":"The length of the response body in octets (8-bit bytes)","enabled":true},{"key":"content-type","value":"text/json;charset=UTF-8","description":"The mime type of this content","enabled":true},{"key":"date","value":"Fri, 29 Sep 2017 05:52:26 GMT","description":"The date and time that the message was sent","enabled":true},{"key":"x-content-type-options","value":"nosniff","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type","enabled":true}],"cookie":[],"responseTime":"241","body":"{\n \"code\": 200,\n \"data\": {\n \"contact\": {\n \"2000\": {\n \"code\": 201,\n \"message\": \"Created\"\n },\n \"2001\": {\n \"code\": 201,\n \"message\": \"Created\"\n }\n }\n },\n \"message\": \"OK\"\n}"},{"id":"a3f663d5-1614-496e-8647-3ed506594425","name":"Not Found","originalRequest":{"method":"PUT","header":[{"key":"ACCEPT","value":"application/x-www-form-urlencoded","disabled":true},{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Authorization","value":"{{vault:basic-auth}}","disabled":true}],"body":{"mode":"urlencoded","urlencoded":[{"key":"contact[2000][type]","value":"ContactType","type":"text","description":"Klucz typu kontaktu"},{"key":"contact[2000][fname]","value":"FirstName","type":"text","description":"Imię"},{"key":"contact[2000][lname]","value":"LastName","type":"text","description":"Nazwisko"},{"key":"contact[2000][name]","value":"OwnName","type":"text","description":"Nazwa własna"},{"key":"contact[2000][email]","value":"test@ipresso.com","type":"text","description":"Adres e-mail"},{"key":"contact[2000][phone]","value":"123123123","type":"text","description":"Numer telefou stacjonarnego"},{"key":"contact[2000][mobile]","value":"321321321","type":"text","description":"Numer telefonu komórkowego"},{"key":"contact[2000][company]","value":"CompanyName","type":"text","description":"Nazwa firmy"},{"key":"contact[2000][city]","value":"Warsaw","type":"text","description":"Miasto"},{"key":"contact[2000][postCode]","value":"00-001","type":"text","description":"Kod pocztowy"},{"key":"contact[2000][street]","value":"streetName","type":"text","description":"Nazwa ulicy"},{"key":"contact[2000][buildingNumber]","value":"1","type":"text","description":"Numer budynku"},{"key":"contact[2000][flatNumber]","value":"2","type":"text","description":"Numer mieszkania"},{"key":"contact[2000][country]","value":"Poland","type":"text","description":"Kraj"},{"key":"contact[2000][region]","value":"Province","type":"text","description":"Zgoda marketingowa o id:1"},{"key":"contact[2000][agreement][1]","value":"1","type":"text","description":"Tablica jednowymiarowa zawierająca tagi"},{"key":"contact[2000][tag][0]","value":"tag1","type":"text","description":"Tablica asocjacyjna z parą identyfikator kategorii => status kategorii"},{"key":"contact[2000][category][1]","value":"1","type":"text","description":"Tablica asocjacyjna z parą identyfikator kategorii => status kategorii"},{"key":"contact[2000][category][3]","value":"1","type":"text","description":"Atrybut dynamiczny typu String o kluczu dynamicAttributeString"},{"key":"contact[2000][dynamicAttributeString]","value":"string","type":"text","description":"Atrybut dynamiczny typu Int o kluczu dynamicAttributeInt"},{"key":"contact[2000][dynamicAttributeInt]","value":"1","type":"text","description":"Atrybut dynamiczny typu Bool (checkbox true/false) o kluczu dynamicAttributecheckbox"},{"key":"contact[2000][dynamicAttributecheckbox]","value":"1","type":"text","description":"Atrybut dynamiczny typu Select (jeden z wielu) o kluczu dynamicAttributeSelect"},{"key":"contact[2000][dynamicAttributeSelect]","value":"selectOption1","type":"text","description":"Atrybut dynamiczny typu Multiselect (wiele z wielu) o kluczu dynamicAttributeMultiselect"},{"key":"contact[2000][dynamicAttributeMultiselect][0]","value":"multiselectOption1","type":"text","description":"Atrybut dynamiczny typu Multiselect (wiele z wielu) o kluczu dynamicAttributeMultiselect"},{"key":"contact[2000][dynamicAttributeMultiselect][1]","value":"multiselectOption2","type":"text","description":"Atrybut dynamiczny typu Text o kluczu dynamicAttributeText"},{"key":"contact[2000][dynamicAttributeText]","value":"text","type":"text","description":"Atrybut dynamiczny typu Date (YYYY-MM-DD) o kluczu dynamicAttributeDate"},{"key":"contact[2000][dynamicAttributeDate]","value":"2017-01-01","type":"text","description":"Atrybut dynamiczny typu Date and Time (YYYY-MM-DD HH:MM) o kluczu dynamicAttributeDateTime"},{"key":"contact[2000][dynamicAttributeDateTime]","value":"2017-01-01 00:00","type":"text","description":"Atrybut dynamiczny typu Time (HH:MM) o kluczu dynamicAttributeTime"},{"key":"contact[2000][dynamicAttributeTime]","value":"00:00","type":"text","description":"Facebook ID"},{"key":"contact[2000][facebook][id]","value":"1","type":"text","description":"Nazwa użytkownika"},{"key":"contact[2000][facebook][name]","value":"User Name","type":"text","description":"Imię"},{"key":"contact[2000][facebook][first_name]","value":"FirstName","type":"text","description":"Nazwisko"},{"key":"contact[2000][facebook][last_name]","value":"LastName","type":"text","description":"Nazwa kampanii UTM"},{"key":"contact[2000][source][utm_campaign]","value":"utm_campaign_test","type":"text","description":"Treść kampanii UTM"},{"key":"contact[2000][source][utm_content]","value":"utm_content_test\t","type":"text","description":"Medium kampanii UTM"},{"key":"contact[2000][source][utm_medium]","value":"utm_medium_test","type":"text","description":"Źródło kampanii UTM"},{"key":"contact[2000][source][utm_source]","value":"utm_source_test","type":"text","description":"Hasło kampanii UTM"},{"key":"contact[2000][source][utm_term]","value":"utm_source_test","type":"text"},{"key":"contact[2000][consents][apiKey]","value":"api_key_test","type":"text"},{"key":"contact[2000][consents][consentGiven]","value":"1","type":"text"},{"key":"contact[2000][consents][externalSource]","value":"external_source_test","type":"text"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/contact/"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"content-length","value":"49","description":"The length of the response body in octets (8-bit bytes)","enabled":true},{"key":"content-type","value":"text/json;charset=UTF-8","description":"The mime type of this content","enabled":true},{"key":"date","value":"Fri, 29 Sep 2017 06:05:55 GMT","description":"The date and time that the message was sent","enabled":true},{"key":"x-content-type-options","value":"nosniff","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type","enabled":true}],"cookie":[],"responseTime":"143","body":"{\n \"code\": 200,\n \"data\": {\n \"contact\": {\n \"20000\": {\n \"code\": 404,\n \"message\": \"Bad request\",\n \"errorCode\": 44\n },\n \"20001\": {\n \"code\": 404,\n \"message\": \"Bad request\",\n \"errorCode\": 44\n }\n }\n },\n \"message\": \"OK\"\n}"}],"_postman_id":"4eccf875-4fcf-4348-ad95-9825d19cd17f"},{"name":"Adding new contact","id":"64917262-7ef4-c3d2-ba2c-cb572b223c7e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"description":"When sending contact attributes, e.g.
\ncityorcityattribute, the allowed characters are: letters, numbers, spaces and special characters: - _ & ( ) [ ]
Using other characters will cause the request to fail.
Contact type api key
\n","key":"contact[0][type]","value":"ContactType"},{"description":"First name
\n","key":"contact[0][fname]","value":"FirstName"},{"description":"Last name
\n","key":"contact[0][lname]","value":"LastName"},{"description":"Own name
\n","key":"contact[0][name]","value":"OwnName"},{"description":"Landline phone number
\n","key":"contact[0][phone]","value":"123123123"},{"description":"Mobile phone number
\n","key":"contact[0][mobile]","value":"321321321"},{"description":"Name of company
\n","key":"contact[0][company]","value":"CompanyName"},{"description":"city
\n","key":"contact[0][city]","value":"Warsaw"},{"description":"Post code
\n","key":"contact[0][postCode]","value":"00-001"},{"description":"Street name
\n","key":"contact[0][street]","value":"streetName"},{"description":"Building number
\n","key":"contact[0][buildingNumber]","value":"1"},{"description":"Flat number
\n","key":"contact[0][flatNumber]","value":"2"},{"description":"Country
\n","key":"contact[0][country]","value":"Poland"},{"description":"Province
\n","key":"contact[0][region]","type":"text","value":"Province"},{"description":"Associative array with a pair - consent IDs or API key => consent status, where 1 = add consent, 2 = delete consent
\n","key":"contact[0][agreement][1]","value":"1"},{"description":"One-dimensional array containing tag
\n","key":"contact[0][tag][0]","value":"tag1"},{"description":"Associative array with a pair - category ID => category status, where 1 = add category, 2 = delete category
\n","key":"contact[0][category][1]","value":"1"},{"description":"Associative array with a pair - category ID => category status, where 1 = add category, 2 = delete category
\n","key":"contact[0][category][3]","value":"1"},{"description":"String dynamic attribute with the dynamicAttributeString key
\n","key":"contact[0][dynamicAttributeString]","value":"string"},{"description":"Dynamic attribute of type Int with the key dynamicAttributeInt
\n","key":"contact[0][dynamicAttributeInt]","value":"1"},{"description":"Dynamic attribute of type Bool (checkbox true / false) with the key dynamicAttributecheckbox
\n","key":"contact[0][dynamicAttributecheckbox]","value":"1"},{"description":"Dynamic attribute of type Select (one of many) with the key dynamicAttributeSelect
\n","key":"contact[0][dynamicAttributeSelect]","value":"selectOptionKey1"},{"description":"Dynamic attribute of the Multiselect type (many of many) with the dynamicAttributeMultiselect key
\n","key":"contact[0][dynamicAttributeMultiselect][0]","value":"multiselectOptionKey1"},{"description":"Dynamic attribute of the Multiselect type (many of many) with the dynamicAttributeMultiselect key
\n","key":"contact[0][dynamicAttributeMultiselect][1]","value":"multiselectOptionKey2"},{"description":"Dynamic attribute of the Text type with the dynamicAttributeText key
\n","key":"contact[0][dynamicAttributeText]","value":"text"},{"description":"Dynamic attribute of the Date type (YYYY-MM-DD) with the dynamicAttributeDate key
\n","key":"contact[0][dynamicAttributeDate]","value":"2017-01-01"},{"description":"Dynamic attribute type Date and Time (YYYY-MM-DD HH: MM) with the dynamicAttributeDateTime key
\n","key":"contact[0][dynamicAttributeDateTime]","value":"2017-01-01 00:00"},{"description":"Dynamic attribute of Time type (HH: MM) with the dynamicAttributeTime key
\n","key":"contact[0][dynamicAttributeTime]","value":"00:00"},{"description":"Associative array with a pair - group ID to access contact => 1 for add group
\n","key":"contact[0][contactAccess][1]","value":"1"},{"description":"Facebook ID
\n","key":"contact[0][facebook][id]","value":"1"},{"description":"User name
\n","key":"contact[0][facebook][name]","value":"User Name"},{"description":"First name
\n","key":"contact[0][facebook][first_name]","value":"FirstName"},{"description":"Last name
\n","key":"contact[0][facebook][last_name]","value":"LastName"},{"description":"UTM campaign name
\n","key":"contact[0][source][utm_campaign]","value":"utm_campaign_test"},{"description":"UTM campaign content
\n","key":"contact[0][source][utm_content]","value":"utm_content_test "},{"description":"UTM campaign medium
\n","key":" contact[0][source][utm_medium]","value":"utm_medium_test"},{"description":"UTM campaign source
\n","key":"contact[0][source][utm_source]","value":"utm_source_test"},{"description":"UTM campaign source
\n","key":"contact[0][source][utm_term]","value":"utm_source_test"},{"key":"contact[0][consents][apiKey]","value":"api_key_test","description":"Consent Api Key
\n","type":"text","uuid":"de019a03-23b1-4e79-a2f9-15d01e81a82b"},{"key":"contact[0][consents][consentGiven]","value":"1","description":"Information on whether consent is granted: true for granted, false for not granted.
\n","type":"text","uuid":"0ccee1f3-db48-40a9-bf88-feda2796b1af"},{"key":"contact[0][consents][externalSource]","value":"external_source_test","description":"Information about the consent source. This is an optional parameter that allows specifying where the consent was obtained or revoked.
\n","type":"text","uuid":"eca262c1-673e-48fb-93d5-7a16e13f67cc"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/contact","description":"In order to add a new contact via iPresso API POST request should be sent to the URL: https://CLIENT_PANEL_ADDRESS/api/2/contact.
Following values may be assigned to a contact:
\nData array for facebook parameters:
\nArray for source parameter:
\n\n\n\n
Static attributesare the default attributes existing in iPresso, such as Name, Surname, Email, Mobile, Street, Country.Dynamic attributesare the attributes created by a customer.Dynamic attributesecan be created with API (Attributes) or in iPresso panel: System -> Dictionaries -> Contacts -> Attributes.
\n\nWhen sending contact attributes, e.g.
\ncityorcityattribute, the allowed characters are: letters, numbers, spaces and special characters: - _ & ( ) [ ]
Using other characters will cause the request to fail.
\n\nThe ability to track a contact in the browser will only be possible after it has been monitored.
\n
To do this, display a tracking pixel to the contact in the browser (as an image in theIMGtag). The pixel address is returned in themonitoringPixelfield.
It is also possible to display anIFRAMEtag whose code is returned in themonitoringCodefield, or to create your ownIFRAMEcode using the address returned in themonitoringLinkfield.
All returned data for contact monitoring is immutable and can be saved so that there is no need to re-download it. Monitoring should occur whenever possible upon each login or return to the website, as users may change browsers/devices.
\n\nThe ability to track a contact in the browser will only be possible after it has been monitored.
\n
\n\nTo do this, use the setContactId method https://js-api-doc.ipresso.pl/methods/identification/set-contact-id
\n
\n\nThis method should be passed the value returned in the
\nhashIdContactfield as a parameter.
\n\nAll returned contact tracking data is immutable and can be saved, eliminating the need to re-download it. Tracking should occur whenever possible upon each login or return to the website, as users may change browsers or devices.
\n
\n\nThe data structure has been developed in the way that allows adding multiple contacts through one request. You can retrieve up to 100 contact in one API request.
\n
In order to add contact with external ID, add ipresso-external-key in headers. It adopts the values of external ID groups defined in iPresso.
In order to add tags to contact you should send POST request to the URL: https://CLIENT_PANEL_ADDRESS/api/2/contact/ID_CONTACT/tag
\n\n","urlObject":{"protocol":"https","path":["api","2","contact","ID_CONTACT","tag"],"host":["CLIENT_PANEL_ADDRESS"],"query":[],"variable":[]}},"response":[{"id":"3f99c58d-be20-e28d-5cb3-52e188795278","name":"Success","originalRequest":{"method":"POST","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"tag[0]","value":"LINKTEST","type":"text"},{"key":"tag[1]","value":"111","type":"text"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/contact/ID_CONTACT/tag"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":"0","body":"{\n \"code\": 201,\n \"data\": true,\n \"message\": \"Created\"\n}"}],"_postman_id":"d7d75e02-534c-883a-3a49-59683d9da7e1"},{"name":"Adding activity to a monitored contact","id":"6e6ec20f-60c3-ab1b-cf1a-7355e7bcb5b0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"}],"body":{"mode":"urlencoded","urlencoded":[{"description":"Parameter
\nTAG NAMEandTAG NAME_2should be replaced with a tag which is to be added. If the chosen tag doesn’t exist it will be automatically created in iPresso and added to a given contact.
Activity key
\n","key":"activity[0][key]","value":"ACTIVITY_1"},{"description":"activity date
\n","key":"activity[0][date]","value":"2017-01-02 00:00:00"},{"description":"Setting the value '7' for the key parameter KEY_PARAM_1
\n","key":"activity[0][parameter][KEY_PARAM_1]","value":"7"},{"description":"Setting the 'string' value for the key parameter KEY_PARAM_2
\n","key":"activity[0][parameter][KEY_PARAM_2]","value":"string"},{"key":"activity[0][parameter][MANY_OF_MANY][0]","value":"first","description":"Setting the 'first' value for the key parameter MANY_OF_MANY
\n","type":"text"},{"key":"activity[0][parameter][MANY_OF_MANY][1]","value":"second","description":"Setting the 'second' value for the key parameter MANY_OF_MANY
\n","type":"text"},{"description":"Activity key
\n","key":"activity[1][key]","value":"ACTIVITY_2"},{"description":"activity date
\n","key":"activity[1][date]","value":"2017-01-02 00:00:00"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/contact/ID_CONTACT/activity","description":"In order to add an activity to a monitored contact send POST request to the URL: https://CLIENT_PANEL_ADDRESS/api/2/contact/ID_CONTACT/activity
\n\nParameter
\nACTIVITY_1andACTIVITY_2should be replaced with KEY of the activity.
\n\nParameter
\nDATEcould be replaced by date and hour of activity creation in format :yyyy-mm-dd hh:mm:ss. This applies to historical provisioning of activities where impose of date from the past is required. With current activity addition parameter should be skipped what implies setting date and hour in format adequate to current Customer time zone.
\n\nParameter
\nKEY_PARAM_1andKEY_PARAM_2should be replaced with parameter key.
\n\nParameter
\nMANY_OF_MANYshould be replaced with parameter key.
Codes:
\nThe returned data parameter contains details regarding additions of particular activities.
Maximum recommended number of activities added in one request is 50.
\n","urlObject":{"protocol":"https","path":["api","2","contact","ID_CONTACT","activity"],"host":["CLIENT_PANEL_ADDRESS"],"query":[],"variable":[]}},"response":[{"id":"6b74b96b-3ed6-531d-147e-530072978600","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"activity[0][key]","value":"ACTIVITY_1","description":"Klucz aktywności"},{"key":"activity[0][date]","value":"2017-01-02 00:00:00","description":"Data aktywności"},{"key":"activity[0][parameter][KEY_PARAM_1]","value":"7","description":"Ustawienie wartości '7' przy parametrze o kluczu KEY_PARAM_1"},{"key":"activity[0][parameter][KEY_PARAM_2]","value":"string","description":"Ustawienie wartości 'string' przy parametrze o kluczu KEY_PARAM_2"},{"key":"activity[0][parameter][MANY_OF_MANY][0]","value":"first","type":"text"},{"key":"activity[0][parameter][MANY_OF_MANY][1]","value":"second","type":"text"},{"key":"activity[1][key]","value":"ACTIVITY_2","description":"Klucz aktywności"},{"key":"activity[1][date]","value":"2017-01-02 00:00:00","description":"Data aktywności"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/contact/ID_CONTACT/activity"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"44","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Tue, 03 Oct 2017 10:29:52 GMT","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"l00ihorbl4lbstskjv8tk92og4","key":"PHPSESSID"}],"responseTime":"158","body":"{\"code\":201,\"data\":true,\"message\":\"Created\"}"},{"id":"19c40b08-ac24-c269-8406-cfb14d975b3b","name":"Error-Wrong Key","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"activity[0][key]","value":"ACTIVITY_1","description":"Klucz aktywności"},{"key":"activity[0][date]","value":"2017-01-02 00:00:00","description":"Data aktywności"},{"key":"activity[0][parameter][KEY_PARAM_1]","value":"7","description":"Ustawienie wartości '7' przy parametrze o kluczu KEY_PARAM_1"},{"key":"activity[0][parameter][KEY_PARAM_2]","value":"string","description":"Ustawienie wartości 'string' przy parametrze o kluczu KEY_PARAM_2"},{"key":"activity[1][key]","value":"ACTIVITY_2","description":"Klucz aktywności"},{"key":"activity[1][date]","value":"2017-01-02 00:00:00","description":"Data aktywności"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/contact/ID_CONTACT/activity"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Encoding","value":"gzip","description":""},{"key":"Content-Length","value":"168","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Tue, 03 Oct 2017 10:59:21 GMT","description":""},{"key":"Vary","value":"Accept-Encoding","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"l00ihorbl4lbstskjv8tk92og4","key":"PHPSESSID"}],"responseTime":"138","body":"{\n \"code\": 201,\n \"data\": [\n {\n \"code\": 404,\n \"message\": \"Not Found\",\n \"errorCode\": 12,\n \"data\": {\n \"key\": \"ACTIVITY_1\",\n \"date\": \"2017-01-02 00:00:00\",\n \"parameter\": {\n \"integerww\": \"7\",\n \"stringww\": \"string\"\n }\n }\n }\n ],\n \"message\": \"Created\"\n}"},{"id":"dff242ff-34c3-94a2-ca66-51d2c497eb46","name":"Error-Not Found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"}],"url":"https://CLIENT_PANEL_ADDRESS/api/2/contact/ID_CONTACT/activity"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"49","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Tue, 03 Oct 2017 10:32:10 GMT","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"l00ihorbl4lbstskjv8tk92og4","key":"PHPSESSID"}],"responseTime":"148","body":"{\"code\":404,\"message\":\"Not Found\",\"errorCode\":10}"}],"_postman_id":"6e6ec20f-60c3-ab1b-cf1a-7355e7bcb5b0"},{"name":"Adding activity to an anonymous contact","id":"1797fae8-3c5a-438b-80d2-30c524aaf02d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"}],"body":{"mode":"urlencoded","urlencoded":[{"description":"Activity key
\n","key":"activity[0][key]","value":"ACTIVITY_1"},{"description":"activity date
\n","key":"activity[0][date]","value":"2017-01-02 00:00:00"},{"description":"Setting the value '7' for the key parameter KEY_PARAM_1
\n","key":"activity[0][parameter][KEY_PARAM_1]","value":"7"},{"description":"Setting the 'string' value for the key parameter KEY_PARAM_2
\n","key":"activity[0][parameter][KEY_PARAM_2]","value":"string"},{"key":"activity[0][parameter][MANY_OF_MANY][0]","value":"first","description":"Setting the 'first' value for the key parameter MANY_OF_MANY
\n","type":"text"},{"key":"activity[0][parameter][MANY_OF_MANY][1]","value":"second","description":"Setting the 'second' value for the key parameter MANY_OF_MANY
\n","type":"text"},{"description":"Activity key
\n","key":"activity[1][key]","value":"ACTIVITY_2"},{"description":"activity date
\n","key":"activity[1][date]","value":"2017-01-02 00:00:00"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/anonymous/ID_CONTACT_ANONYM/activity","description":"In order to add an activity to an anonymous contact send POST request to the URL: https://CLIENT_PANEL_ADDRESS/api/2/anonymous/ID_CONTACT_ANONYM/activity
\n\nParameter
\nACTIVITY_1andACTIVITY_2should be replaced with KEY of the activity.
\n\nParameter
\nDATEcould be replaced by date and hour of activity creation in format :yyyy-mm-dd hh:mm:ss. This applies to historical provisioning of activities where impose of date from the past is required. With current activity addition parameter should be skipped what implies setting date and hour in format adequate to current Customer time zone.
\n\nParameter
\nKEY_PARAM_1andKEY_PARAM_2should be replaced with parameter key.
\n\nParameter
\nMANY_OF_MANYshould be replaced with parameter key.
Codes:
\nThe returned data parameter contains details regarding additions of particular activities.
Maximum recommended number of activities added in one request is 50.
\n","urlObject":{"protocol":"https","path":["api","2","anonymous","ID_CONTACT_ANONYM","activity"],"host":["CLIENT_PANEL_ADDRESS"],"query":[],"variable":[]}},"response":[{"id":"2c590f2a-05ce-4522-bcbd-8049cd140389","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"activity[0][key]","value":"ACTIVITY_1","description":"Klucz aktywności"},{"key":"activity[0][date]","value":"2017-01-02 00:00:00","description":"Data aktywności"},{"key":"activity[0][parameter][KEY_PARAM_1]","value":"7","description":"Ustawienie wartości '7' przy parametrze o kluczu KEY_PARAM_1"},{"key":"activity[0][parameter][KEY_PARAM_2]","value":"string","description":"Ustawienie wartości 'string' przy parametrze o kluczu KEY_PARAM_2"},{"key":"activity[0][parameter][MANY_OF_MANY][0]","value":"first","type":"text"},{"key":"activity[0][parameter][MANY_OF_MANY][1]","value":"second","type":"text"},{"key":"activity[1][key]","value":"ACTIVITY_2","description":"Klucz aktywności"},{"key":"activity[1][date]","value":"2017-01-02 00:00:00","description":"Data aktywności"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/anonymous/ID_CONTACT_ANONYM/activity"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"44","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Tue, 03 Oct 2017 10:29:52 GMT","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"l00ihorbl4lbstskjv8tk92og4","key":"PHPSESSID"}],"responseTime":null,"body":"{\"code\":201,\"data\":true,\"message\":\"Created\"}"},{"id":"2c4889b2-d0e1-4fdd-884e-8fd33dc23962","name":"Error-Not Found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"}],"url":"https://CLIENT_PANEL_ADDRESS/api/2/anonymous/ID_CONTACT_ANONYM/activity"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"49","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Tue, 03 Oct 2017 10:32:10 GMT","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"l00ihorbl4lbstskjv8tk92og4","key":"PHPSESSID"}],"responseTime":null,"body":"{\"code\":404,\"message\":\"Not Found\",\"errorCode\":10}"},{"id":"f7d3adf1-d21e-4fa0-b099-4f8b812610b8","name":"Error-Wrong Key","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"activity[0][key]","value":"ACTIVITY_1","description":"Klucz aktywności"},{"key":"activity[0][date]","value":"2017-01-02 00:00:00","description":"Data aktywności"},{"key":"activity[0][parameter][KEY_PARAM_1]","value":"7","description":"Ustawienie wartości '7' przy parametrze o kluczu KEY_PARAM_1"},{"key":"activity[0][parameter][KEY_PARAM_2]","value":"string","description":"Ustawienie wartości 'string' przy parametrze o kluczu KEY_PARAM_2"},{"key":"activity[1][key]","value":"ACTIVITY_2","description":"Klucz aktywności"},{"key":"activity[1][date]","value":"2017-01-02 00:00:00","description":"Data aktywności"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/anonymous/ID_CONTACT_ANONYM/activity"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Encoding","value":"gzip","description":""},{"key":"Content-Length","value":"168","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Tue, 03 Oct 2017 10:59:21 GMT","description":""},{"key":"Vary","value":"Accept-Encoding","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"l00ihorbl4lbstskjv8tk92og4","key":"PHPSESSID"}],"responseTime":null,"body":"{\n \"code\": 201,\n \"data\": [\n {\n \"code\": 404,\n \"message\": \"Not Found\",\n \"errorCode\": 12,\n \"data\": {\n \"key\": \"ACTIVITY_1\",\n \"date\": \"2017-01-02 00:00:00\",\n \"parameter\": {\n \"integerww\": \"7\",\n \"stringww\": \"string\"\n }\n }\n }\n ],\n \"message\": \"Created\"\n}"}],"_postman_id":"1797fae8-3c5a-438b-80d2-30c524aaf02d"},{"name":"Adding category to a contact","id":"38cbb27d-9954-4ce1-84d5-7e14535f51ee","request":{"method":"POST","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"url":"https://CLIENT_PANEL_ADDRESS/api/2/contact/ID_CONTACT/category","description":"In order to add category to a contact send POST request to the URL: https://CLIENT_PANEL_ADDRESS/api/2/contact/ID_CONTACT/category
\n\nParameter
\nID_CONTACTshould be replaced with contact’s ID.
\n\n","urlObject":{"protocol":"https","path":["api","2","contact","ID_CONTACT","category"],"host":["CLIENT_PANEL_ADDRESS"],"query":[],"variable":[]}},"response":[{"id":"902afc44-1d9c-937f-d3b5-d86b843e2bbc","name":"Success","originalRequest":{"method":"POST","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"category[0]","value":"ID_CATEGORY","type":"text"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/contact/ID_CONTACT/category"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"44","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Tue, 03 Oct 2017 10:47:01 GMT","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"5ru4jlnfi6pmao3os1q84vnc45","key":"PHPSESSID"}],"responseTime":"221","body":"{\"code\":201,\"data\":true,\"message\":\"Created\"}"},{"id":"29e15868-b405-72fa-56ca-b6afbfac9ee8","name":"Error-Not Found","originalRequest":{"method":"POST","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"category[0]","value":"ID_CATEGORY","type":"text"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/contact/ID_CONTACT/category"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"49","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Tue, 03 Oct 2017 13:07:38 GMT","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"5ru4jlnfi6pmao3os1q84vnc45","key":"PHPSESSID"}],"responseTime":"222","body":"{\"code\":404,\"message\":\"Not Found\",\"errorCode\":44}"}],"_postman_id":"38cbb27d-9954-4ce1-84d5-7e14535f51ee"},{"name":"Connect contacts","id":"c9b680f0-0646-53f0-5bbf-c879470f7183","request":{"method":"POST","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"connection[0]","value":"ID_CONTACT_2","type":"text"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/contact/ID_CONTACT/connection","description":"Parameter
\nID_CATEGORYshould be replaced with ID’s category.
In order to connect contacts send POST request to the URL: https://CLIENT_PANEL_ADRESS/api/2/contact/ID_CONTACT/connection
\n\nParameter
\nID_CONTACT_2should be replaced withID_CONTACTof the contact with which the connection is to be established.
In order to be able to establish connections between contacts it is necessary for the contacts to possess types allowing for such connections(e.g. Parent -> Child). Types of contacts may be set in iPresso and API panels
Action key
\n","key":"action[0][key]","value":"ACTION_1"},{"description":"Action date
\n","key":"action[0][date]","value":"YYYY-MM-DD HH:MM:SS"},{"description":"Setting the for the key parameter ACTION_PARAM_KEY_1
\n","key":"action[0][parameter][ACTION_PARAM_KEY_1]","value":"VALUE_1"},{"description":"Setting the for the key parameter ACTION_PARAM_KEY_2
\n","key":"action[0][parameter][ACTION_PARAM_KEY_2]","value":"VALUE_2"},{"description":"Setting the for the key parameter MANY_OF_MANY
\n","key":"action[0][parameter][MANY_OF_MANY][0]","type":"text","value":"VALUE_1"},{"description":"Setting the for the key parameter MANY_OF_MANY
\n","key":"action[0][parameter][MANY_OF_MANY][1]","type":"text","value":"VALUE_2"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/contact/ID_CONTACT/action","description":"In order to add action to a monitored contact send POST request to the URL: https://CLIENT_PANEL_ADRESS/api/2/contact/ID_CONTACT/action
\n\nParameter
\nACTION_1should be replaced with action KEY.
\n\nParameter
\nDATEcould be replaced by date and hour of activity creation in format :yyyy-mm-dd hh:mm:ss. This applies to historical provisioning of activities where impose of date from the past is required. With current activity addition parameter should be skipped what implies setting date and hour in format adequate to current Customer time zone.
\n\nParameter
\nACTION_PARAM_KEY_1andACTION_PARAM_KEY_2should be replaced with parameter key.
\n\nParameter
\nMANY_OF_MANYshould be replaced with parameter key.
Codes:
\nThe returned data parameter contains details regarding additions of particular actions.
Maximum recommended number of actions added in one request is 50.
\n","urlObject":{"protocol":"https","path":["api","2","contact","ID_CONTACT","action"],"host":["CLIENT_PANEL_ADDRESS"],"query":[],"variable":[]}},"response":[{"id":"120cc5ca-ddbd-39cd-c963-f47296c963fb","name":"Success","originalRequest":{"method":"POST","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"action[0][key]","value":"ACTION_1","type":"text"},{"key":"action[0][date]","value":"YYYY-MM-DD HH:MM:SS","type":"text"},{"key":"action[0][parameter][ACTION_PARAM_KEY_1]","value":"VALUE_1","type":"text"},{"key":"action[0][parameter][ACTION_PARAM_KEY_2]","value":"VALUE_2","type":"text"},{"key":"action[0][parameter][MANY_OF_MANY][0]","value":"VALUE_1","type":"text"},{"key":"action[0][parameter][MANY_OF_MANY][1]","value":"VALUE_2","type":"text"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/contact/ID_CONTACT/action"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"44","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Wed, 04 Oct 2017 07:17:53 GMT","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"l00ihorbl4lbstskjv8tk92og4","key":"PHPSESSID"}],"responseTime":"329","body":"{\"code\":201,\"data\":true,\"message\":\"Created\"}"},{"id":"1e1a9aa5-68ba-f871-1327-d03b7b55d107","name":"Error-Not Found","originalRequest":{"method":"POST","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"action[0][key]","value":"ACTION_1"},{"key":"action[0][date]","value":"YYYY-MM-DD HH:MM:SS"},{"key":"action[0][parameter][ACTION_PARAM_KEY_1]","value":"VALUE_1"},{"key":"action[0][parameter][ACTION_PARAM_KEY_2]","value":"VALUE_2"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/contact/ID_CONTACT/action"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Encoding","value":"gzip","description":""},{"key":"Content-Length","value":"159","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Wed, 04 Oct 2017 07:44:04 GMT","description":""},{"key":"Vary","value":"Accept-Encoding","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"l00ihorbl4lbstskjv8tk92og4","key":"PHPSESSID"}],"responseTime":"203","body":"{\n \"code\": 404,\n \"data\": [\n {\n \"code\": 404,\n \"message\": \"Not Found\",\n \"errorCode\": 12,\n \"data\": {\n \"key\": \"ACTION_1\",\n \"date\": \"YYYY-MM-DD HH:MM:SS\",\n \"parameter\": {\n \"ACTION_PARAM_KEY_1\": \"VALUE_1\",\n \"ACTION_PARAM_KEY_2\": \"VALUE_2\"\n }\n }\n }\n ],\n \"message\": \"Not Found\"\n}"}],"_postman_id":"239d36dc-bee0-b709-62ae-7f8888104f77"},{"name":"Adding action to an anonymous contact","id":"5d153a54-2f27-4238-a26c-0b3a67d911f4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"action[0][key]","value":"ACTION_1","description":"Action key
\n"},{"key":"action[0][date]","value":"YYYY-MM-DD HH:MM:SS","description":"Action date
\n"},{"key":"action[0][parameter][ACTION_PARAM_KEY_1]","value":"VALUE_1","description":"Setting the for the key parameter ACTION_PARAM_KEY_1
\n"},{"key":"action[0][parameter][ACTION_PARAM_KEY_2]","value":"VALUE_2","description":"Setting the for the key parameter ACTION_PARAM_KEY_2
\n"},{"key":"action[0][parameter][MANY_OF_MANY][0]","value":"VALUE_1","description":"Setting the for the key parameter MANY_OF_MANY
\n","type":"text"},{"key":"action[0][parameter][MANY_OF_MANY][1]","value":"VALUE_2","description":"Setting the for the key parameter MANY_OF_MANY
\n","type":"text"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/anonymous/ID_CONTACT_ANONYM/action","description":"In order to add action to an anonymous contact send POST request to the URL: https://CLIENT_PANEL_ADRESS/api/2/anonymous/ID_CONTACT_ANONYM/action
\n\nParameter
\nACTION_1should be replaced with action KEY.
\n\nParameter
\nDATEcould be replaced by date and hour of activity creation in format :yyyy-mm-dd hh:mm:ss. This applies to historical provisioning of activities where impose of date from the past is required. With current activity addition parameter should be skipped what implies setting date and hour in format adequate to current Customer time zone.
\n\nParameter
\nACTION_PARAM_KEY_1andACTION_PARAM_KEY_2should be replaced with parameter key.
\n\nParameter
\nMANY_OF_MANYshould be replaced with parameter key.
Codes:
\nThe returned data parameter contains details regarding additions of particular actions.
Maximum recommended number of actions added in one request is 50.
\n","urlObject":{"protocol":"https","path":["api","2","anonymous","ID_CONTACT_ANONYM","action"],"host":["CLIENT_PANEL_ADDRESS"],"query":[],"variable":[]}},"response":[{"id":"bc3e5594-a979-406b-8ff5-66f5f1b0cbe0","name":"Success","originalRequest":{"method":"POST","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"action[0][key]","value":"ACTION_1","type":"text"},{"key":"action[0][date]","value":"YYYY-MM-DD HH:MM:SS","type":"text"},{"key":"action[0][parameter][ACTION_PARAM_KEY_1]","value":"VALUE_1","type":"text"},{"key":"action[0][parameter][ACTION_PARAM_KEY_2]","value":"VALUE_2","type":"text"},{"key":"action[0][parameter][MANY_OF_MANY][0]","value":"VALUE_1","type":"text"},{"key":"action[0][parameter][MANY_OF_MANY][0]","value":"VALUE_2","type":"text"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/anonymous/ID_CONTACT_ANONYM/action"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"44","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Wed, 04 Oct 2017 07:17:53 GMT","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"l00ihorbl4lbstskjv8tk92og4","key":"PHPSESSID"}],"responseTime":null,"body":"{\"code\":201,\"data\":true,\"message\":\"Created\"}"},{"id":"8d8c12e4-135d-4b9b-8b37-57d06f468955","name":"Error-Not Found","originalRequest":{"method":"POST","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"action[0][key]","value":"ACTION_1"},{"key":"action[0][date]","value":"YYYY-MM-DD HH:MM:SS"},{"key":"action[0][parameter][ACTION_PARAM_KEY_1]","value":"VALUE_1"},{"key":"action[0][parameter][ACTION_PARAM_KEY_2]","value":"VALUE_2"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/anonymous/ID_CONTACT_ANONYM/action"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Encoding","value":"gzip","description":""},{"key":"Content-Length","value":"159","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Wed, 04 Oct 2017 07:44:04 GMT","description":""},{"key":"Vary","value":"Accept-Encoding","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"l00ihorbl4lbstskjv8tk92og4","key":"PHPSESSID"}],"responseTime":null,"body":"{\n \"code\": 404,\n \"data\": [\n {\n \"code\": 404,\n \"message\": \"Not Found\",\n \"errorCode\": 12,\n \"data\": {\n \"key\": \"ACTION_1\",\n \"date\": \"YYYY-MM-DD HH:MM:SS\",\n \"parameter\": {\n \"ACTION_PARAM_KEY_1\": \"VALUE_1\",\n \"ACTION_PARAM_KEY_2\": \"VALUE_2\"\n }\n }\n }\n ],\n \"message\": \"Not Found\"\n}"}],"_postman_id":"5d153a54-2f27-4238-a26c-0b3a67d911f4"},{"name":"Adding consents to contacts","id":"5834791e-08dc-7987-e600-695e0ef01696","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"agreement[AGREEMENT]","value":"AGREEMENT_STATUS","type":"text"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/contact/ID_CONTACT/agreement","description":"In order to add consent send POST request to the URL: https://CLIENT_PANEL_ADRESS/api/2/contact/ID_CONTACT/agreement.
In the request you should include consent containing associative array the key to which is consent’s ID or API key, and whose content is consent status.
\n\n\nParameter
\nAGREEMENTshould be replaced with ID number or API key of the consent.
\n\nParameter
\nAGREEMENT_STATUSshould be replaced with ID consent status.
Types of statuses:
\n1 - add consent,
\n2 - delete consent.
\nIn order to set type of a contact send POST request to the URL: https://CLIENT_PANEL_ADDRESS/api/2/contact/ID_CONTACT/type
\n\n","urlObject":{"protocol":"https","path":["api","2","contact","ID_CONTACT","type"],"host":["CLIENT_PANEL_ADDRESS"],"query":[],"variable":[]}},"response":[{"id":"b261af9d-eac3-39a8-01da-5ba814214908","name":"Success","originalRequest":{"method":"POST","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"type","value":"TYPE_NAME","type":"text"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/contact/ID_CONTACT/type"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"44","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Tue, 03 Oct 2017 13:23:33 GMT","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"l00ihorbl4lbstskjv8tk92og4","key":"PHPSESSID"}],"responseTime":"170","body":"{\"code\":201,\"data\":true,\"message\":\"Created\"}"},{"id":"8d48046a-2d8e-a58b-1bd5-255ed8fb4cd4","name":"Error-Not Found","originalRequest":{"method":"POST","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"type","value":"TYPE_NAME","type":"text"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/contact/ID_CONTACT/type"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"49","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Tue, 03 Oct 2017 13:23:52 GMT","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"l00ihorbl4lbstskjv8tk92og4","key":"PHPSESSID"}],"responseTime":"166","body":"{\"code\":404,\"message\":\"Not Found\",\"errorCode\":44}"}],"_postman_id":"89b33ee2-2f83-1c89-3948-dfd4c2d22eb5"},{"name":"Searching contact actions and activities","id":"7e3ce391-4d79-422f-addf-58b4c8bbd9f9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"description":"Parameter
\nTYPE_NAMEshould be replaced with type name.
The \"date from\" of the activity/action
\n","key":"activity[dateFrom]","value":"YYYY-MM-DD HH:MM:SS"},{"description":"The \"date to\" of the activity/action
\n","key":"activity[dateTo]","value":"YYYY-MM-DD HH:MM:SS"},{"description":"Activity/Action API key
\n","key":"activity[key][0]","value":"ACTIVITY_KEY"},{"description":"Results page
\n","key":"page","value":"VALUE"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/contact/ID_CONTACT/activity/search?","description":"In order to search for actions and/or contact activity, POST request should be sent to the URL:
https://CLIENT_PANEL_ADRESS/api/2/contact/ID_CONTACT/activity/search?
\n\nThe
\ndateFromparameter should be replaced with the start date of the activity/action period
\n\nThe
\ndateToparameter should be replaced with the end date of the activity/action period
\n\nThe
\nACTIVITY_KEYparameter should be replaced with the Activity/Action API key.
\n\nThe
\npageparameter should be replaced with the value of the page you want to display.
The maximum number of displayed activities/actions on the page is 1000.
\nMaximum number of returned pages is 10.
\n","urlObject":{"protocol":"https","path":["api","2","contact","ID_CONTACT","activity","search"],"host":["CLIENT_PANEL_ADDRESS"],"query":[{"key":"","value":null}],"variable":[]}},"response":[{"id":"85608d6f-4206-4a79-a15f-b12830c7ec5d","name":"Success","originalRequest":{"method":"POST","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"activity[dateFrom]","value":"2020-12-12 01:25:30"},{"key":"activity[dateTo]","value":"2020-12-12 01:25:30"},{"key":"activity[key][0]","value":"contact_add_by_api"},{"key":"page","value":"1"}]},"url":{"raw":"https://CLIENT_PANEL_ADDRESS/api/2/contact/12345/activity/search","protocol":"https","host":["CLIENT_PANEL_ADDRESS"],"path":["api","2","contact","12345","activity","search"],"query":[{"key":"activity[dateFrom]","value":"2020-12-12","disabled":true},{"key":"activity[dateTo]","value":"2022-12-12","disabled":true},{"key":"activity[key][0]","value":"contact_add_by_api","disabled":true},{"key":"page","value":"1","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Encoding","value":"gzip","description":""},{"key":"Content-Length","value":"159","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Wed, 04 Oct 2017 07:44:04 GMT","description":""},{"key":"Vary","value":"Accept-Encoding","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"l00ihorbl4lbstskjv8tk92og4","key":"PHPSESSID"}],"responseTime":"203","body":"{\n \"code\": 200,\n \"data\": {\n \"total\": 1,\n \"rows\": [\n {\n \"activity_date\": \"2022-11-24 08:29:33\",\n \"id_contact\": 12345,\n \"activity_key\": \"contact_add_by_api\",\n \"activity_type\": 1\n }\n ],\n \"allPage\": 1\n },\n \"message\": \"OK\"\n}"},{"id":"da8e7602-16dd-483a-bdd7-ea357b240361","name":"Error-Contact doesn't exist","originalRequest":{"method":"POST","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"activity[dateFrom]","value":"2020-12-12 01:25:30"},{"key":"activity[dateTo]","value":"2020-12-12 01:25:30"},{"key":"activity[key][0]","value":"contact_add_by_api"},{"key":"page","value":"1"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/contact/ID_CONTACT/activity/search"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Encoding","value":"gzip","description":""},{"key":"Content-Length","value":"159","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Wed, 04 Oct 2017 07:44:04 GMT","description":""},{"key":"Vary","value":"Accept-Encoding","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"l00ihorbl4lbstskjv8tk92og4","key":"PHPSESSID"}],"responseTime":"203","body":"{\n \"code\": 404,\n \"message\": \"Not found\",\n \"errorCode\": 13\n}"}],"_postman_id":"7e3ce391-4d79-422f-addf-58b4c8bbd9f9"},{"name":"Mass addition of categories to contacts","id":"40e450f0-9369-f238-48b3-043602e870d8","request":{"method":"POST","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"contact[ID_CONTACT][0]","value":"ID_CATEGORY_1"},{"key":"contact[ID_CONTACT][1]","value":"ID_CATEGORY_2"},{"key":"contact[ID_CONTACT_2][0]","value":"ID_CATEGORY_1"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/contact/category","description":"In order to perform mass addition of categories to contacts send POST request to the URL: https://CLIENT_PANEL_ADDRESS/api/2/contact/category.
In request include multi-dimensional array contact containing contact IDs as keys and one-dimensional arrays containing category IDs as its contents.
\n\n\n","urlObject":{"protocol":"https","path":["api","2","contact","category"],"host":["CLIENT_PANEL_ADDRESS"],"query":[],"variable":[]}},"response":[{"id":"1a991f21-33f8-6410-4058-60b0ec7f3ecd","name":"Success","originalRequest":{"method":"POST","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"contact[ID_CONTACT][0]","value":"ID_CATEGORY_1","type":"text"},{"key":"contact[ID_CONTACT][1]","value":"ID_CATEGORY_2","type":"text"},{"key":"contact[ID_CONTACT_2][0]","value":"ID_CATEGORY_1","type":"text"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/contact/category"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"44","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Tue, 03 Oct 2017 13:35:11 GMT","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"5ru4jlnfi6pmao3os1q84vnc45","key":"PHPSESSID"}],"responseTime":"246","body":"{\"code\":201,\"data\":true,\"message\":\"Created\"}"},{"id":"57a14d61-757c-16e3-3f78-6f8a347927e1","name":"error-Not Found","originalRequest":{"method":"POST","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"contact[ID_CONTACT][0]","value":"ID_CATEGORY_1"},{"key":"contact[ID_CONTACT][1]","value":"ID_CATEGORY_2"},{"key":"contact[ID_CONTACT_2][0]","value":"ID_CATEGORY_1"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/contact/category"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"49","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Tue, 03 Oct 2017 13:36:51 GMT","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"5ru4jlnfi6pmao3os1q84vnc45","key":"PHPSESSID"}],"responseTime":"223","body":"{\"code\":404,\"message\":\"Not Found\",\"errorCode\":51}"}],"_postman_id":"40e450f0-9369-f238-48b3-043602e870d8"},{"name":"Mass addition of consents to contacts","id":"7ded9c2a-01ac-fddb-6a77-d33265e1b3a2","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"contact[ID_CONTACT_1][AGREEMENT_1]","value":"AGREEMENT_STATUS"},{"key":"contact[ID_CONTACT_2][AGREEMENT_2]","value":"AGREEMENT_STATUS"}]},"url":"https://CLIENT_PANEL_ADDRESS.pl/api/2/contact/agreement","description":"Parameter
\nID_CATEGORYshould be replaced with ID’s category which is to be assigned.
In order to perform mass addition of consents to contacts send POST request to the URL: https://CLIENT_PANEL_ADRESS/api/2/contact/agreement
\n\nParameter
\nAGREEMENTshould be replaced with ID or API key of the consent.
\n\nParameter
\nAGREEMENT_STATUSshould be replaced with contact’s ID.
Types of statuses:
\n1 - add consent,
\n2 - delete consent.
\nActivity API key
\n","key":"contact[CONTACT_ID_1][0][key]","value":"ACTIVITY_KEY_1"},{"description":"Activity occurrence date - not required
\n","key":"contact[CONTACT_ID_1][0][date]","value":"2017-01-01 00:00:00"},{"description":"Adding the value for the parameter with the key ACTIVITY_PARAM_KEY_1
\n","key":"contact[CONTACT_ID_1][0][parameter][ACTIVITY_PARAM_KEY_1]","value":"VALUE_1"},{"description":"Adding the value for the parameter with the key ACTIVITY_PARAM_KEY_2
\n","key":"contact[CONTACT_ID_1][0][parameter][ACTIVITY_PARAM_KEY_2]","value":"VALUE_2"},{"key":"contact[CONTACT_ID_1][0][parameter][MANY_OF_MANY][0]","type":"text","value":"VALUE_1","description":"Adding the value for the parameter with the key MANY_OF_MANY
\n"},{"key":"contact[CONTACT_ID_1][0][parameter][MANY_OF_MANY][1]","value":"VALUE_2","description":"Adding the value for the parameter with the key MANY_OF_MANY
\n","type":"text"},{"description":"Activity API key
\n","key":"contact[CONTACT_ID_2][0][key]","value":"ACTIVITY_KEY_2"},{"description":"Activity occurrence date - not required
\n","key":"contact[CONTACT_ID_2][0][date]","value":"2017-01-01 00:00:00"},{"description":"Adding the value for the parameter with the key ACTIVITY_PARAM_KEY_1
\n","key":"contact[CONTACT_ID_2][0][parameter][ACTIVITY_PARAM_KEY_1]","value":"VALUE_1"},{"description":"Adding the value for the parameter with the key ACTIVITY_PARAM_KEY_2
\n","key":"contact[CONTACT_ID_2][0][parameter][ACTIVITY_PARAM_KEY_2]","value":"VALUE_2"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/contact/activity","description":"In order to perform mass addition of activities to contacts send POST request to the URL: https://CLIENT_PANEL_ADRESS/api/2/contact/activity
\n\nParameter
\nACTIVITY_KEY_1andACTIVITY_KEY_2should be replaced with KEY of the activity.
\n\nParameter
\nACTIVITY_PARAM_KEY_1andACTIVITY_PARAM_KEY_2should be replaced with parameter key.
\n\nParameter
\nMANY_OF_MANYshould be replaced with parameter key.
Maximum recommended number of activities added in one request is 50.
\n","urlObject":{"protocol":"https","path":["api","2","contact","activity"],"host":["CLIENT_PANEL_ADDRESS"],"query":[],"variable":[]}},"response":[{"id":"de06fd35-6009-1b5e-d2dc-97559c941755","name":"Success","originalRequest":{"method":"POST","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"","value":"","disabled":true}],"body":{"mode":"urlencoded","urlencoded":[{"key":"contact[CONTACT_ID_1][0][key]","value":"ACTIVITY_KEY_1","description":"Klucz API aktywności"},{"key":"contact[CONTACT_ID_1][0][date]","value":"2017-01-01 00:00:00","description":"Data wystąpienia aktywności - niewymagane"},{"key":"contact[CONTACT_ID_1][0][parameter][ACTIVITY_PARAM_KEY_1]","value":"VALUE_1","description":"Dodanie wartości dla parametru o kluczu ACTIVITY_PARAM_KEY_1"},{"key":"contact[CONTACT_ID_1][0][parameter][ACTIVITY_PARAM_KEY_2]","value":"VALUE_2","description":"Dodanie wartości dla parametru o kluczu ACTIVITY_PARAM_KEY_2"},{"key":"contact[CONTACT_ID_1][0][parameter][MANY_OF_MANY][0]","value":"VALUE_1","type":"text"},{"key":"contact[CONTACT_ID_1][0][parameter][MANY_OF_MANY][1]","value":"VALUE_2","type":"text"},{"key":"contact[CONTACT_ID_2][0][key]","value":"ACTIVITY_KEY_2","description":"Klucz API aktywności"},{"key":"contact[CONTACT_ID_2][0][date]","value":"2017-01-01 00:00:00","description":"Data wystąpienia aktywności - niewymagane"},{"key":"contact[CONTACT_ID_2][0][parameter][ACTIVITY_PARAM_KEY_1]","value":"VALUE_1","description":"Dodanie wartości dla parametru o kluczu ACTIVITY_PARAM_KEY_1"},{"key":"contact[CONTACT_ID_2][0][parameter][ACTIVITY_PARAM_KEY_2]","value":"VALUE_2","description":"Dodanie wartości dla parametru o kluczu ACTIVITY_PARAM_KEY_2"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/contact/activity"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"44","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Wed, 04 Oct 2017 06:57:18 GMT","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"l00ihorbl4lbstskjv8tk92og4","key":"PHPSESSID"}],"responseTime":"155","body":"{\"code\":201,\"data\":true,\"message\":\"Created\"}"}],"_postman_id":"93299f16-af1c-a285-f4bb-ec2b41545ee1"},{"name":"Mass addition of actions to contacts","id":"e8f089ed-5c3a-3e5b-0389-3097b722a6d1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Authorization","value":"Basic YXBpOmFwaS5BUEkuMTIz"}],"body":{"mode":"urlencoded","urlencoded":[{"description":"Action API key
\n","key":"contact[ID_CONTACT_1][0][key]","value":"ACTION_1"},{"description":"Action occurrence date - not required
\n","key":"contact[ID_CONTACT_1][0][date]","value":"YYYY-MM-DD HH:MM:SS"},{"description":"Adding the value for the parameter with the key ACTION_PARAM_KEY_1
\n","key":"contact[ID_CONTACT_1][0][parameter][ACTION_PARAM_KEY_1]","value":"VALUE_1"},{"description":"Adding the value for the parameter with the key ACTION_PARAM_KEY_2
\n","key":"contact[ID_CONTACT_1][0][parameter][ACTION_PARAM_KEY_2]","value":"VALUE_2"},{"key":"contact[CONTACT_ID_1][0][parameter][MANY_OF_MANY][0]","value":"VALUE_1","description":"Adding the value for the parameter with the key MANY_OF_MANY
\n","type":"text"},{"key":"contact[CONTACT_ID_1][0][parameter][MANY_OF_MANY][0]","value":"VALUE_2","description":"Adding the value for the parameter with the key MANY_OF_MANY
\n","type":"text"},{"description":"Action API key
\n","key":"contact[ID_CONTACT_2][0][key]","value":"ACTION_2"},{"description":"Action occurrence date - not required
\n","key":"contact[ID_CONTACT_2][0][date]","value":"YYYY-MM-DD HH:MM:SS"},{"description":"Adding the value for the parameter with the key ACTION_PARAM_KEY_1
\n","key":"contact[ID_CONTACT_2][0][parameter][ACTION_PARAM_KEY_1]","value":"VALUE_1"},{"description":"Adding the value for the parameter with the key ACTION_PARAM_KEY_2
\n","key":"contact[ID_CONTACT_2][0][parameter][ACTION_PARAM_KEY_2]","value":"VALUE_2"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/contact/action","description":"In order to perform mass addition of actions to contacts send POST request to the URL: https://CLIENT_PANEL_ADRESS/api/2/contact/action
\n\nParameter
\nACTION_1andACTION_2should be replaced with action KEY.
\n\nParameter
\nACTION_PARAM_KEY_1andACTION_PARAM_KEY_2should be replaced with parameter key.
\n\nParameter
\nMANY_OF_MANYshould be replaced with parameter key.
Maximum recommended number of actions added in one request is 50.
\n","urlObject":{"protocol":"https","path":["api","2","contact","action"],"host":["CLIENT_PANEL_ADDRESS"],"query":[],"variable":[]}},"response":[{"id":"ef0f24ef-ae58-678c-3f6e-74dc5edefe22","name":"Success","originalRequest":{"method":"POST","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Authorization","value":"Basic YXBpOmFwaS5BUEkuMTIz"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"contact[ID_CONTACT_1][0][key]","value":"ACTION_1"},{"key":"contact[ID_CONTACT_1][0][date]","value":"YYYY-MM-DD HH:MM:SS"},{"key":"contact[ID_CONTACT_1][0][parameter][ACTION_PARAM_KEY_1]","value":"VALUE_1"},{"key":"contact[ID_CONTACT_1][0][parameter][ACTION_PARAM_KEY_2]","value":"VALUE_2"},{"key":"contact[CONTACT_ID_1][0][parameter][MANY_OF_MANY][0]","value":"VALUE_1","type":"text"},{"key":"contact[CONTACT_ID_1][0][parameter][MANY_OF_MANY][1]","value":"VALUE_2","type":"text"},{"key":"contact[ID_CONTACT_2][0][key]","value":"ACTION_2"},{"key":"contact[ID_CONTACT_2][0][date]","value":"YYYY-MM-DD HH:MM:SS"},{"key":"contact[ID_CONTACT_2][0][parameter][ACTION_PARAM_KEY_1]","value":"VALUE_1"},{"key":"contact[ID_CONTACT_2][0][parameter][ACTION_PARAM_KEY_2]","value":"VALUE_2"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/contact/action"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"content-length","value":"44","description":""},{"key":"content-type","value":"text/json;charset=UTF-8","description":""},{"key":"date","value":"Fri, 06 Oct 2017 06:32:45 GMT","description":""},{"key":"x-content-type-options","value":"nosniff","description":""}],"cookie":[],"responseTime":"156","body":"{\"code\":201,\"data\":true,\"message\":\"Created\"}"},{"id":"5f457e91-585b-c370-e9cd-75b84b24c314","name":"Error - Not Found","originalRequest":{"method":"POST","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Authorization","value":"Basic YXBpOmFwaS5BUEkuMTIz"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"contact[ID_CONTACT_1][0][key]","value":"ACTION_1"},{"key":"contact[ID_CONTACT_1][0][date]","value":"YYYY-MM-DD HH:MM:SS"},{"key":"contact[ID_CONTACT_1][0][parameter][ACTION_PARAM_KEY_1]","value":"VALUE_1"},{"key":"contact[ID_CONTACT_1][0][parameter][ACTION_PARAM_KEY_2]","value":"VALUE_2"},{"key":"contact[ID_CONTACT_2][0][key]","value":"ACTION_2"},{"key":"contact[ID_CONTACT_2][0][date]","value":"YYYY-MM-DD HH:MM:SS"},{"key":"contact[ID_CONTACT_2][0][parameter][ACTION_PARAM_KEY_1]","value":"VALUE_1"},{"key":"contact[ID_CONTACT_2][0][parameter][ACTION_PARAM_KEY_2]","value":"VALUE_2"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/contact/action"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"content-encoding","value":"gzip","description":""},{"key":"content-length","value":"150","description":""},{"key":"content-type","value":"text/json;charset=UTF-8","description":""},{"key":"date","value":"Fri, 06 Oct 2017 06:36:43 GMT","description":""},{"key":"vary","value":"Accept-Encoding","description":""},{"key":"x-content-type-options","value":"nosniff","description":""}],"cookie":[],"responseTime":"206","body":"{\n \"code\": 201,\n \"data\": {\n \"ID_CONTACT_1\": {\n \"code\": 400,\n \"message\": \"Bad Request\",\n \"errorCode\": 55,\n \"data\": {\n \"action\": {\n \"code\": 404,\n \"message\": \"Not Found\",\n \"errorCode\": 12,\n \"data\": {\n \"key\": \"ACTION_1\"\n }\n }\n }\n },\n \"ID_CONTACT_2\": {\n \"code\": 400,\n \"message\": \"Bad Request\",\n \"errorCode\": 55,\n \"data\": {\n \"action\": {\n \"code\": 404,\n \"message\": \"Not Found\",\n \"errorCode\": 12,\n \"data\": {\n \"key\": \"ACTION_2\"\n }\n }\n }\n }\n },\n \"message\": \"Created\"\n}"}],"_postman_id":"e8f089ed-5c3a-3e5b-0389-3097b722a6d1"},{"name":"Mass addition of tags to contacts","id":"fe97e56d-cdcc-cbcc-a8e0-9c2c0f5cfec5","request":{"method":"POST","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"contact[ID_CONTACT_1]","value":"TAG_NAME_1"},{"key":"contact[ID_CONTACT_2]","value":"TAG_NAME_2"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/contact/tag","description":"In order to perform mass addition of tags to contacts send POST request to the URL: https://CLIENT_PANEL_ADDRESS/api/2/contact/tag.
The request should include one-dimensional array category containing IDs of selected categories.
\n\n\n","urlObject":{"protocol":"https","path":["api","2","contact","tag"],"host":["CLIENT_PANEL_ADDRESS"],"query":[],"variable":[]}},"response":[{"id":"51a61908-8a55-46fa-5bd9-79a9526db2cb","name":"Success","originalRequest":{"method":"POST","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"contact[ID_CONTACT_1]","value":"TAG_NAME_1"},{"key":"contact[ID_CONTACT_2]","value":"TAG_NAME_2"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/contact/tag"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"44","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Wed, 04 Oct 2017 07:02:31 GMT","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"5ru4jlnfi6pmao3os1q84vnc45","key":"PHPSESSID"}],"responseTime":"198","body":"{\"code\":201,\"data\":true,\"message\":\"Created\"}"},{"id":"111e34db-5668-e9c2-46d7-342c91b8d70d","name":"Error-Not Found","originalRequest":{"method":"POST","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"contact[ID_CONTACT_1]","value":"TAG_NAME_1"},{"key":"contact[ID_CONTACT_2]","value":"TAG_NAME_2","type":"text"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/contact/tag"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"49","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Wed, 04 Oct 2017 06:43:17 GMT","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"5ru4jlnfi6pmao3os1q84vnc45","key":"PHPSESSID"}],"responseTime":"142","body":"{\"code\":404,\"message\":\"Not Found\",\"errorCode\":49}"}],"_postman_id":"fe97e56d-cdcc-cbcc-a8e0-9c2c0f5cfec5"},{"name":"Delete contact","id":"154693f5-1d95-941c-5998-b8c15a3f9963","request":{"method":"DELETE","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"url":"https://CLIENT_PANEL_ADDRESS/api/2/contact/ID_CONTACT","description":"Parameter
\nID_CONTACT_1andID_CONTACT_2should be replaced with contact’s ID.
In order to delete a contact you should send DELETE request to the URL: https://CLIENT_PANEL_ADDRESS/api/2/contact/ID_CONTACT
In order to delete contact’s tag send DELETE request to the URL: https://CLIENT_PANEL_ADDRESS/api/2/contact/ID_CONTACT/tag/ID_TAG
\n\nParameter
\nID_CONTACTshould be replaced with contact’s ID.
\n\n","urlObject":{"port":"","path":["CLIENT_PANEL_ADDRESS","api","2","contact","ID_CONTACT","tag","ID_TAG"],"host":["https"],"query":[],"variable":[]}},"response":[{"id":"24f24427-c411-cd30-4e15-31c581f9ad3e","name":"Success","originalRequest":{"method":"DELETE","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"url":"https:/CLIENT_PANEL_ADDRESS/api/2/contact/ID_CONTACT/tag/ID_TAG"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"39","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Tue, 03 Oct 2017 10:30:27 GMT","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"5ru4jlnfi6pmao3os1q84vnc45","key":"PHPSESSID"}],"responseTime":"146","body":"{\"code\":200,\"data\":true,\"message\":\"OK\"}"},{"id":"e9ef3890-705d-56d6-d5e1-c10ddfa0ae3a","name":"Error - Not Found","originalRequest":{"method":"DELETE","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"url":"https:/CLIENT_PANEL_ADDRESS/api/2/contact/ID_CONTACT/tag/ID_TAG"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"34","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Tue, 03 Oct 2017 10:32:16 GMT","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"5ru4jlnfi6pmao3os1q84vnc45","key":"PHPSESSID"}],"responseTime":"238","body":"{\"code\":404,\"message\":\"Not Found\"}"}],"_postman_id":"792dec32-4d65-6e0a-03f9-88b20bafb0ab"},{"name":"Deleting contact’s category","id":"615c65ab-ff9c-d1df-ba5e-a56506311e0c","request":{"method":"DELETE","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"url":"https:/CLIENT_PANEL_ADDRESS/api/2/contact/ID_CONTACT/category/ID_CATEGORY","description":"Parameter
\nID_TAGshould be replaced with ID of a tag.
In order to delete categories send DELETE request to the URL: https://CLIENT_PANEL_ADDRESS/api/2/contact/ID_CONTACT/category/ID_CATEGORY
\n\n","urlObject":{"port":"","path":["CLIENT_PANEL_ADDRESS","api","2","contact","ID_CONTACT","category","ID_CATEGORY"],"host":["https"],"query":[],"variable":[]}},"response":[{"id":"3a6831ad-8316-c45e-50fa-76348722fe58","name":"Success","originalRequest":{"method":"DELETE","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"url":"https:/CLIENT_PANEL_ADDRESS/api/2/contact/ID_CONTACT/category/ID_CATEGORY"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"39","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Tue, 03 Oct 2017 11:02:56 GMT","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"5ru4jlnfi6pmao3os1q84vnc45","key":"PHPSESSID"}],"responseTime":"235","body":"{\"code\":200,\"data\":true,\"message\":\"OK\"}"},{"id":"f9d75e9e-37c3-255c-f62e-1e895ec38dbf","name":"Error - Not Found","originalRequest":{"method":"DELETE","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"url":"https:/CLIENT_PANEL_ADDRESS/api/2/contact/ID_CONTACT/category/ID_CATEGORY"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"34","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Tue, 03 Oct 2017 11:03:42 GMT","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"5ru4jlnfi6pmao3os1q84vnc45","key":"PHPSESSID"}],"responseTime":"182","body":"{\"code\":404,\"message\":\"Not Found\"}"}],"_postman_id":"615c65ab-ff9c-d1df-ba5e-a56506311e0c"},{"name":"Delete consent of a given ID or API key from a contact of a given ID","id":"8922aaee-3bd9-346e-06e5-64a49b947a47","request":{"method":"DELETE","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"url":"https://CLIENT_PANEL_ADDRESS/api/2/contact/ID_CONTACT/agreement/ID_AGREEMENT","description":"Parameter
\nID_CATEGORYshould be replaced with ID’s category.
In order to delete consent of a given ID or API key from a contact of a given ID send DELETE request to the URL: https://CLIENT_PANEL_ADDRESS/api/2/contact/ID_CONTACT/agreement/AGREEMENT
\n\nParameter
\nAGREEMENTshould be replaced with consent’s ID or API key.
\n\n","urlObject":{"protocol":"https","path":["api","2","contact","ID_CONTACT","agreement","ID_AGREEMENT"],"host":["CLIENT_PANEL_ADDRESS"],"query":[],"variable":[]}},"response":[{"id":"5c718f5a-adae-1890-40e3-f0b20fe61c4e","name":"Success","originalRequest":{"method":"DELETE","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"url":"https://CLIENT_PANEL_ADDRESS/api/2/contact/ID_CONTACT/agreement/AGREEMENT"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"39","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Tue, 03 Oct 2017 12:59:45 GMT","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"5ru4jlnfi6pmao3os1q84vnc45","key":"PHPSESSID"}],"responseTime":"192","body":"{\"code\":200,\"data\":true,\"message\":\"OK\"}"}],"_postman_id":"8922aaee-3bd9-346e-06e5-64a49b947a47"},{"name":"Delete contact’s connections","id":"54476e47-3fa7-a356-54f1-d6649a55942f","request":{"method":"DELETE","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"url":"https://CLIENT_PANEL_ADDRESS/api/2/contact/ID_CONTACT/connection/ID_CONTACT_2","description":"Parameter
\nID_CONTACTshould be replaced with contact’s ID.
In order to delete connections between contacts send DELETE request to the URL: https://CLIENT_PANEL_ADRESS/api/2/contact/ID_CONTACT/connection/ID_CONTACT_2
\n\nParameter
\nID_CONTACTshould be replaced with contact’s ID.
\n\n","urlObject":{"protocol":"https","path":["api","2","contact","ID_CONTACT","connection","ID_CONTACT_2"],"host":["CLIENT_PANEL_ADDRESS"],"query":[],"variable":[]}},"response":[{"id":"9f38a220-45b3-54be-f399-3992abcd7b49","name":"Success","originalRequest":{"method":"DELETE","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"url":"https://CLIENT_PANEL_ADDRESS/api/2/contact/ID_CONTACT/connection/ID_CONTACT_2"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"27","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Wed, 04 Oct 2017 05:58:28 GMT","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"l00ihorbl4lbstskjv8tk92og4","key":"PHPSESSID"}],"responseTime":"127","body":"{\"code\":200,\"message\":\"OK\"}"},{"id":"44a6f061-4058-386f-38d2-0c84b8990cd7","name":"Error-Forbidden","originalRequest":{"method":"DELETE","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"url":"https://CLIENT_PANEL_ADDRESS/api/2/contact/ID_CONTACT/connection/ID_CONTACT_2"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"49","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Wed, 04 Oct 2017 05:59:58 GMT","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"l00ihorbl4lbstskjv8tk92og4","key":"PHPSESSID"}],"responseTime":"102","body":"{\"code\":403,\"message\":\"Forbidden\",\"errorCode\":47}"}],"_postman_id":"54476e47-3fa7-a356-54f1-d6649a55942f"}],"id":"a9d0c4d5-7020-5be1-00a0-3403c0dfa67c","_postman_id":"a9d0c4d5-7020-5be1-00a0-3403c0dfa67c","description":""},{"name":"Dynamic contact attributes","item":[{"name":"Get available attributes","id":"370a4135-2353-c9f1-b991-0aea4b20cf26","request":{"method":"GET","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"formdata","formdata":[]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/attribute","description":"Parameter
\nID_CONTACT_2should be replaced with the ID contact whose connect is to be deleted.
In order to get dynamic attributes send GET request to the URL: https://CLIENT_PANEL_ADDRESS/api/2/attribute
In order to edit attribute option send PUT request to the URL: https://CLIENT_PANEL_ADDRESS/api/2/attribute/ATTRIBUTE_KEY/option/OPTION_KEY
\n\nParameter
\nATTRIBUTE_KEYshould be replaced with attribute API key.
\n\nParameter
\nOPTION_KEYshould be replaced with option API key.
\n\nParameter
\nNEW_OPTION_KEYshould be replaced with new option API key.
\n\n","urlObject":{"protocol":"https","path":["api","2","attribute","ATTRIBUTE_KEY","option","OPTION_KEY"],"host":["CLIENT_PANEL_ADDRESS"],"query":[],"variable":[]}},"response":[{"id":"16a6dd23-987e-92f6-5c5f-281c403a0343","name":"Success 201","originalRequest":{"method":"PUT","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"TOKEN"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"option[key]","value":"NEW_OPTION_KEY","type":"text"},{"key":"option[value]","value":"OPTION_NAME","type":"text"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/attribute/ATTRIBUTE_KEY/option/OPTION_KEY"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"32","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":"The mime type of this content"},{"key":"Date","value":"Tue, 08 May 2018 07:39:03 GMT","description":"The date and time that the message was sent"},{"key":"X-Content-Type-Options","value":"nosniff","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Powered-By","value":"PHP/7.0.25","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"panel.ipresso.dev","path":"/","secure":false,"value":"da30eed51d21c312da91a42ea36adc9c","key":"PHPSESSID"}],"responseTime":null,"body":"{\"code\":201,\"message\":\"Created\"}"},{"id":"1cd6580d-87a9-ff91-994a-ad8d70e7023a","name":"Error 404","originalRequest":{"method":"PUT","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"TOKEN"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"option[key]","value":"NEW_OPTION_KEY","type":"text"},{"key":"option[value]","value":"OPTION_NAME","type":"text"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/attribute/ATTRIBUTE_KEY/option/OPTION_KEY"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"50","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":"The mime type of this content"},{"key":"Date","value":"Tue, 08 May 2018 08:44:56 GMT","description":"The date and time that the message was sent"},{"key":"X-Content-Type-Options","value":"nosniff","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Powered-By","value":"PHP/7.0.25","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"panel.ipresso.dev","path":"/","secure":false,"value":"da30eed51d21c312da91a42ea36adc9c","key":"PHPSESSID"}],"responseTime":null,"body":"{\"code\":404,\"message\":\"Not Found\",\"errorCode\":104}"},{"id":"f1399765-ecf6-d526-aa3e-ddde87441a6d","name":"Error 404","originalRequest":{"method":"PUT","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"TOKEN"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"option[key]","value":"NEW_OPTION_KEY","type":"text"},{"key":"option[value]","value":"OPTION_NAME","type":"text"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/attribute/ATTRIBUTE_KEY/option/OPTION_KEY"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"49","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":"The mime type of this content"},{"key":"Date","value":"Tue, 08 May 2018 06:42:30 GMT","description":"The date and time that the message was sent"},{"key":"X-Content-Type-Options","value":"nosniff","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Powered-By","value":"PHP/7.0.25","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"panel.ipresso.dev","path":"/","secure":false,"value":"da30eed51d21c312da91a42ea36adc9c","key":"PHPSESSID"}],"responseTime":null,"body":"{\"code\":404,\"message\":\"Not Found\",\"errorCode\":65}"}],"_postman_id":"1e8fc14a-12e4-6e49-c048-11ebb1177faf"},{"name":"Add new dynamic attributes","id":"8122b008-2dcc-6bc1-7bd0-0fe57149af05","request":{"method":"POST","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"name","value":"ATTRIBUTE_NAME"},{"key":"key","value":"ATTRIBUTE_KEY"},{"key":"type","value":"ATTRIBUTE_TYPE"},{"key":"precision","value":"ATTRIBUTE_PRECISION","type":"text"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/attribute","description":"Parameter
\nOPTION_NAMEshould be replaced with option name.
In order to add new dynamic attribute send POST request to the URL: https://CLIENT_PANEL_ADDRESS/api/2/attribute
\n\nParameter
\nATTRIBUTE_NAMEshould be replace with an attribute’s name.
\n\nParameter
\nATTRIBUTE_KEYshould be replaced with attribute key.
\n\nParameter
\nATTRIBUTE_TYPEshould be replaced with attribute type.
\n\nParameter
\nATTRIBUTE_PRECISIONshould be replaced with the number of decimal places in the floating-point numbers (only the decimal attribute).
Kinds of available attribute types:
\n","urlObject":{"protocol":"https","path":["api","2","attribute"],"host":["CLIENT_PANEL_ADDRESS"],"query":[],"variable":[]}},"response":[{"id":"388bc5c3-1328-9c54-7ef0-fe9c8b44863f","name":"Success","originalRequest":{"method":"POST","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"name","value":"ATTRIBUTE_NAME","type":"text"},{"key":"key","value":"ATTRIBUTE_KEY","type":"text"},{"key":"type","value":"ATTRIBUTE_TYPE","type":"text"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/attribute"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Encoding","value":"gzip","description":""},{"key":"Content-Length","value":"107","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Thu, 05 Oct 2017 07:27:02 GMT","description":""},{"key":"Vary","value":"Accept-Encoding","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"l00ihorbl4lbstskjv8tk92og4","key":"PHPSESSID"}],"responseTime":"2530","body":"{\n \"code\": 201,\n \"data\": {\n \"attribute\": {\n \"id\": 64,\n \"name\": \"test\",\n \"key\": \"test\",\n \"type\": \"string\"\n }\n },\n \"message\": \"Created\"\n}"},{"id":"79613f72-2069-3452-184b-fc84eff22a8f","name":"Error-Found","originalRequest":{"method":"POST","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"name","value":"ATTRIBUTE_NAME","type":"text"},{"key":"key","value":"ATTRIBUTE_KEY","type":"text"},{"key":"type","value":"ATTRIBUTE_TYPE","type":"text"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/attribute"},"status":"Found","code":302,"_postman_previewlanguage":"json","header":[{"key":"Content-Encoding","value":"gzip","description":""},{"key":"Content-Length","value":"102","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Thu, 05 Oct 2017 07:37:53 GMT","description":""},{"key":"Vary","value":"Accept-Encoding","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"l00ihorbl4lbstskjv8tk92og4","key":"PHPSESSID"}],"responseTime":"213","body":"{\n \"code\": 302,\n \"data\": {\n \"attribute\": {\n \"name\": \"test\",\n \"key\": \"test\",\n \"type\": \"string\"\n }\n },\n \"message\": \"Found\"\n}"}],"_postman_id":"8122b008-2dcc-6bc1-7bd0-0fe57149af05"},{"name":"Add attribute option","id":"86319036-018c-ced4-2cc4-e47cac5d247a","request":{"method":"POST","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"option[OPTION_KEY]","value":"OPTION_VALUE","type":"text"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/attribute/ATRIBUTE_KEY/option","description":"In order to add attribute option send POST request to the URL: https://CLIENT_PANEL_ADDRESS/api/2/attribute/ATTRIBUTE_KEY/option
\n\nParameter
\nCLIENT_PANEL_ADDRESSshould be replaced with the URL address of iPresso.
\n\nParameter
\nATTRIBUTE_KEYshould be replaced with attribute API key.
\n\nParameter
\nOPTION_KEYshould be replaced with option key.
\n\n","urlObject":{"protocol":"https","path":["api","2","attribute","ATRIBUTE_KEY","option"],"host":["CLIENT_PANEL_ADDRESS"],"query":[],"variable":[]}},"response":[{"id":"10ad5c5e-a3b7-52f5-6b9c-2b1af3ee2c16","name":"Success 201","originalRequest":{"method":"POST","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"TOKEN"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"option","value":"['OPTION_KEY1' => 'OPTION_VALUE']","type":"text"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/attribute/ATTRIBUTE_KEY/option"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"32","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":"The mime type of this content"},{"key":"Date","value":"Thu, 12 Apr 2018 09:21:43 GMT","description":"The date and time that the message was sent"},{"key":"X-Content-Type-Options","value":"nosniff","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Content-Type-Options","value":"nosniff","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Powered-By","value":"PHP/7.0.25","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"panel.qa11-ipresso.encja.eu","path":"/","secure":false,"value":"ae83775dd6e73bf76cc2af44642b005e","key":"PHPSESSID"}],"responseTime":null,"body":"{\"code\":201,\"message\":\"Created\"}"},{"id":"8e944b50-5bf2-1173-e5bb-6db1d3896c95","name":"Error - Not Found","originalRequest":{"method":"POST","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"TOKEN"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"option","value":"['OPTION_KEY1' => 'OPTION_VALUE']","type":"text"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/attribute/ATRIBUTE_KEY/option"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"32","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":"The mime type of this content"},{"key":"Date","value":"Thu, 12 Apr 2018 09:21:43 GMT","description":"The date and time that the message was sent"},{"key":"X-Content-Type-Options","value":"nosniff","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Content-Type-Options","value":"nosniff","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Powered-By","value":"PHP/7.0.25","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"panel.qa11-ipresso.encja.eu","path":"/","secure":false,"value":"ae83775dd6e73bf76cc2af44642b005e","key":"PHPSESSID"}],"responseTime":null,"body":"{\n \"code\": 404,\n \"message\": \"Not Found\",\"errorCode\":65\n}"},{"id":"95ce408a-45f7-3d5c-b995-793b84932bb0","name":"Error - Bad Request","originalRequest":{"method":"POST","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"TOKEN"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"option","value":"['OPTION_KEY1' => 'OPTION_VALUE']","type":"text"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/attribute/ATRIBUTE_KEY/option"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"32","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":"The mime type of this content"},{"key":"Date","value":"Thu, 12 Apr 2018 09:21:43 GMT","description":"The date and time that the message was sent"},{"key":"X-Content-Type-Options","value":"nosniff","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Content-Type-Options","value":"nosniff","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Powered-By","value":"PHP/7.0.25","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"panel.qa11-ipresso.encja.eu","path":"/","secure":false,"value":"ae83775dd6e73bf76cc2af44642b005e","key":"PHPSESSID"}],"responseTime":null,"body":"{\n \"code\": 400,\n \"message\": \"Bad request\"\n}"}],"_postman_id":"86319036-018c-ced4-2cc4-e47cac5d247a"},{"name":"Delete attribute option","id":"f4ca4170-6e28-ddb0-be99-769031fddea0","request":{"method":"DELETE","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"formdata","formdata":[]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/attribute/ATTRIBUTE_KEY/option/OPTION_KEY","description":"Parameter
\nOPTION_VALUEshould be replaced with option name.
In order to delete attribute option send DELETE request to the URL: https://CLIENT_PANEL_ADDRESS/api/2/attribute/ATTRIBUTE_KEY/option/OPTION_KEY
\n\nParameter
\nATTRIBUTE_KEYshould be replaced with attribute API key.
\n\nParameter
\nOPTION_KEYshould be replaced with option API key.
Can't delete option used by contact.
\n","urlObject":{"protocol":"https","path":["api","2","attribute","ATTRIBUTE_KEY","option","OPTION_KEY"],"host":["CLIENT_PANEL_ADDRESS"],"query":[],"variable":[]}},"response":[{"id":"b4ad573a-64fc-096b-1ec9-8b507846da45","name":"Success 200","originalRequest":{"method":"DELETE","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"TOKEN"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"url":"https://CLIENT_PANEL_ADDRESS/api/2/attribute/ATTRIBUTE_KEY/option/OPTION_KEY"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"27","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":"The mime type of this content"},{"key":"Date","value":"Tue, 08 May 2018 06:30:29 GMT","description":"The date and time that the message was sent"},{"key":"X-Content-Type-Options","value":"nosniff","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Powered-By","value":"PHP/7.0.25","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"panel.ipresso.dev","path":"/","secure":false,"value":"da30eed51d21c312da91a42ea36adc9c","key":"PHPSESSID"}],"responseTime":null,"body":"{\"code\":200,\"message\":\"OK\"}"},{"id":"4c7649f9-b7d2-1bce-6bf3-50c4155a2c82","name":"Error 403","originalRequest":{"method":"DELETE","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"TOKEN"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"url":"https://CLIENT_PANEL_ADDRESS/api/2/attribute/ATTRIBUTE_KEY/option/OPTION_KEY"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"49","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":"The mime type of this content"},{"key":"Date","value":"Tue, 08 May 2018 06:31:16 GMT","description":"The date and time that the message was sent"},{"key":"X-Content-Type-Options","value":"nosniff","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Powered-By","value":"PHP/7.0.25","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"panel.ipresso.dev","path":"/","secure":false,"value":"da30eed51d21c312da91a42ea36adc9c","key":"PHPSESSID"}],"responseTime":null,"body":"{\"code\":403,\"message\":\"Forbidden\",\"errorCode\":64}"},{"id":"7039fc13-856b-e2b4-0476-9e46a4194251","name":"Error 404","originalRequest":{"method":"DELETE","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"TOKEN"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"url":"https://CLIENT_PANEL_ADDRESS/api/2/attribute/ATTRIBUTE_KEY/option/OPTION_KEY"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"49","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":"The mime type of this content"},{"key":"Date","value":"Tue, 08 May 2018 06:27:35 GMT","description":"The date and time that the message was sent"},{"key":"X-Content-Type-Options","value":"nosniff","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Powered-By","value":"PHP/7.0.25","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"panel.ipresso.dev","path":"/","secure":false,"value":"da30eed51d21c312da91a42ea36adc9c","key":"PHPSESSID"}],"responseTime":null,"body":"{\"code\":404,\"message\":\"Not Found\",\"errorCode\":65}"}],"_postman_id":"f4ca4170-6e28-ddb0-be99-769031fddea0"}],"id":"2432c169-eba4-3a5e-b6c7-26bb63d87849","_postman_id":"2432c169-eba4-3a5e-b6c7-26bb63d87849","description":""},{"name":"Contact Activities","item":[{"name":"Get available activities","id":"aecd45a0-5990-2cc4-badf-06aaa93c9fb6","request":{"method":"GET","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"url":"https://CLIENT_PANEL_ADDRESS/api/2/activity","description":"In order to get available activities send GET request to the URL: https://CLIENT_PANEL_ADDRESS/api/2/activity
In order to edit activity, send PUT request to the URL: https://CLIENT_PANEL_ADDRESS/api/2/activity/ACTIVITY_KEY
\n\nParameter
\nACTIVITY_KEYshould be replaced with a name of an activity key.
The edit option allows you to change the activity name, change the name of activity parameters and add new parameters to existing activities. When adding new parameters to an existing activity, proceed in the same way as when adding a new activity (enter the name, key, and parameter type).
\nAvailable parameter types:
\ninteger for numerical values, decimal for floating point numbers, string for text contents, datetime for data and time, bool for true/false values, multi for dynamically generated table,dictionary for dictionaries.In order to add new activity send POST request to the URL: https://CLIENT_PANEL_ADDRESS/api/2/activity
Parameter ACTIVITY_KEY should be replaced with a name of an activity key.
Parameter ACTIVITY_NAME should be replaced with the name of an activity.
Parameter PARAMETER_KEY should be replaced with a parameter key.
Parameter PARAMETER_TYPE should be replaced with the type of data.
Available parameter types:
\ninteger for numerical values, decimal for floating point numbers, string for text contents, datetime for data and time, bool for true/false values, multi for dynamically generated table,dictionary for dictionaries.In order to perform mass addition of activities send POST request to the URL: https://CLIENT_PANEL_ADDRESS/api/2/activity/KEY/contact
\n\nParameter
\nID_CONTACT_Xshould be replaced with contact's ID.
\n\nParameter
\nKEYshould be replaced with an activity key.
\n\nParameter 'DATE\" could be replaced by date and hour of activity creation in format :
\nyyyy-mm-dd hh:mm:ss. This applies to historical provisioning of activities where impose of date from the past is required. With current activity addition parameter should be skipped what implies setting date and hour in format adequate to current Customer time zone.
\n\nParameter
\nPARAMETER_KEYshould be replaced with parameter key.
\n\n","urlObject":{"protocol":"https","path":["api","2","activity","KEY","contact"],"host":["CLIENT_PANEL_ADDRESS"],"query":[],"variable":[]}},"response":[{"id":"4097ea7e-786c-d189-e74c-2a37c49d06a0","name":"Success","originalRequest":{"method":"POST","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"date","value":"","type":"text"},{"key":"parameter[decimal6]","value":"15","type":"text"},{"key":"parameter[integer]","value":"16","type":"text"},{"key":"contact[0]","value":"306154","type":"text"},{"key":"contact[1]","value":"306153","type":"text"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/activity/KEY/contact"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"44","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Thu, 05 Oct 2017 06:24:58 GMT","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"l00ihorbl4lbstskjv8tk92og4","key":"PHPSESSID"}],"responseTime":"203","body":"{\"code\":201,\"data\":true,\"message\":\"Created\"}"},{"id":"7b26cc33-da93-8c20-89c3-83ce697fb629","name":"Error-Not Found","originalRequest":{"method":"POST","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"url":"https://CLIENT_PANEL_ADDRESS/api/2/activity/KEY/contact"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"49","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Thu, 05 Oct 2017 06:26:43 GMT","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"l00ihorbl4lbstskjv8tk92og4","key":"PHPSESSID"}],"responseTime":"89","body":"{\"code\":404,\"message\":\"Not Found\",\"errorCode\":11}"}],"_postman_id":"4bdf5673-2b01-961d-0cff-120beb735aaf"},{"name":"Delete activity","id":"a4f0ef0d-7beb-f85a-9c3f-c24c4c77afb1","request":{"method":"DELETE","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"url":"https://CLIENT_PANEL_ADDRESS/api/2/activity/ACTIVITY_KEY","description":"Parameter
\nCONTENTshould be replaced with parameter's content.
In order to delete activity you should send DELETE request to the URL: https://CLIENT_PANEL_ADDRESS/api/2/activity/ACTIVITY_KEY
\n\n","urlObject":{"protocol":"https","path":["api","2","activity","ACTIVITY_KEY"],"host":["CLIENT_PANEL_ADDRESS"],"query":[],"variable":[]}},"response":[{"id":"7b664e91-dfac-0105-e3ad-c089c9cf00b6","name":"Success","originalRequest":{"method":"DELETE","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"url":"https://CLIENT_PANEL_ADDRESS/api/2/activity/ACTIVITY_KEY"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"27","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Thu, 05 Oct 2017 06:13:05 GMT","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"l00ihorbl4lbstskjv8tk92og4","key":"PHPSESSID"}],"responseTime":"228","body":"{\"code\":200,\"message\":\"OK\"}"},{"id":"a99133d0-48d3-0a23-f5e6-2816accf88ea","name":"Error-Not Found","originalRequest":{"method":"DELETE","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"url":"https://CLIENT_PANEL_ADDRESS/api/2/activity/ACTIVITY_KEY"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"49","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Thu, 05 Oct 2017 06:13:51 GMT","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"l00ihorbl4lbstskjv8tk92og4","key":"PHPSESSID"}],"responseTime":"143","body":"{\"code\":404,\"message\":\"Not Found\",\"errorCode\":12}"},{"id":"15d11b25-030b-4a71-a9f1-23fa1c228c37","name":"Error-In used","originalRequest":{"method":"DELETE","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"url":"https://CLIENT_PANEL_ADDRESS/api/2/activity/ACTIVITY_KEY"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 403,\n \"message\": \"Forbidden\",\n \"errorCode\": 123\n}"}],"_postman_id":"a4f0ef0d-7beb-f85a-9c3f-c24c4c77afb1"}],"id":"d5fe19e2-7fb0-5cf2-0f07-9f09946742a5","_postman_id":"d5fe19e2-7fb0-5cf2-0f07-9f09946742a5","description":""},{"name":"Contact Actions","item":[{"name":"Get actions","id":"65260dc9-6082-afcc-d79d-0fd09c4c2cbe","request":{"method":"GET","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"url":"https://CLIENT_PANEL_ADDRESS/api/2/action","description":"Parameter
\nACTIVITY_KEYshould be replaced with a name of an activity key.
In order to get actions send GET request to the URL:\n https://CLIENT_PANEL_ADDRESS/api/2/action
In order to edit action, send PUT request to the URL: https://CLIENT_PANEL_ADDRESS/api/2/action/ACTION_KEY
\n\nParameter
\nACTION_KEYshould be replaced with a name of an action key.
**The edit option allows you to change the action name, change the name of action parameters and add new parameters to existing actions. When adding new parameters to an existing action, proceed in the same way as when adding a new action (enter the name, key, and parameter type). **
\nAvailable parameter types:
\ninteger for numerical values, decimal for floating point numbers, string for text contents, datetime for data and time, bool for true/false values, multi for dynamically generated table,dictionary for dictionaries.Action key
\n"},{"key":"name","value":"ACTION_NAME"},{"key":"parameter[1][key]","value":"PARAMETER_KEY_1"},{"key":"parameter[1][name]","value":"PARAMETER_NAME_1"},{"key":"parameter[1][type]","value":"integer"},{"key":"parameter[2][key]","value":"PARAMETER_KEY_2"},{"key":"parameter[2][name]","value":"PARAMETER_NAME_2"},{"key":"parameter[2][type]","value":"decimal"},{"key":"parameter[3][key]","value":"PARAMETER_KEY_3"},{"key":"parameter[3][name]","value":"PARAMETER_NAME_3"},{"key":"parameter[3][type]","value":"string"},{"key":"parameter[4][key]","value":"PARAMETER_KEY_4"},{"key":"parameter[4][name]","value":"PARAMETER_NAME_4"},{"key":"parameter[4][type]","value":"dictionary"},{"key":"parameter[4][parameter][0]","value":"OPTION_1"},{"key":"parameter[4][parameter][1]","value":"OPTION_2"},{"key":"parameter[5][key]","value":"PARAMETER_KEY_5"},{"key":"parameter[5][name]","value":"PARAMETER_NAME_5"},{"key":"parameter[5][type]","value":"datetime"},{"key":"parameter[6][key]","value":"PARAMETER_KEY_6"},{"key":"parameter[6][name]","value":"PARAMETER_NAME_6"},{"key":"parameter[6][type]","value":"bool"},{"key":"parameter7][key]","value":"PARAMETER_KEY_7"},{"key":"parameter[7][name]","value":"PARAMETER_name_7"},{"key":"parameter[7][type]","value":"multi"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/action","description":"In order to add actions send POST request to the URL: https://CLIENT_PANEL_ADDRESS/api/2/action
\n\nParameter
\nACTION_KEYshould be replaced with an action key.
\n\nParameter
\nPARAMETER_KEYshould be replaced with a parameter key.
\n\nParameter
\nPARAMETER_TYPEshould be replaced with the type of data.
Available parameter types:
\ninteger for numerical values, decimal for floating point numbers, string for text contents, datetime for data and time, bool for true/false values, multi for dynamically generated table,dictionary for dictionaries.In order to add actions to contacts send POST request to the URL: https://CLIENT_PANEL_ADDRESS/api/2/action/ACTION_KEY/contact
\n\nParameter
\nID_CONTACT_Xshould be replaced with contact's ID.
\n\nParameter
\nKEYshould be replaced with action key.
\n\nParameter
\nPARAMETER_KEYshould be replaced with parameter key.
\n\nParameter
\nCONTENTshould be replaced with parameter's content.
\n\n","urlObject":{"protocol":"https","path":["api","2","action","KEY","contact"],"host":["CLIENT_PANEL_ADDRESS"],"query":[],"variable":[]}},"response":[{"id":"b7411281-b865-af47-d9bb-3e54e933cb8f","name":"Success","originalRequest":{"method":"POST","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"parameter[string]","value":"rrr"},{"key":"parameter[wwww2]","value":"777"},{"key":"contact[0]","value":"306157"},{"key":"contact[1]","value":"306154"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/action/KEY/contact"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"content-length","value":"44","description":""},{"key":"content-type","value":"text/json;charset=UTF-8","description":""},{"key":"date","value":"Fri, 06 Oct 2017 10:16:38 GMT","description":""},{"key":"x-content-type-options","value":"nosniff","description":""}],"cookie":[],"responseTime":"189","body":"{\"code\":201,\"data\":true,\"message\":\"Created\"}"},{"id":"c8caef0f-1ecc-c6b6-79ae-00e61a1d9f7a","name":"Error-Not Found","originalRequest":{"method":"POST","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"parameter[wwww]","value":"str"},{"key":"parameter[wwww2]","value":"16"},{"key":"contact[0]","value":"306154"},{"key":"contact[1]","value":"306153"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/action/KEY/contact"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"49","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Fri, 06 Oct 2017 07:40:24 GMT","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"l00ihorbl4lbstskjv8tk92og4","key":"PHPSESSID"}],"responseTime":"287","body":"{\"code\":404,\"message\":\"Not Found\",\"errorCode\":11}"}],"_postman_id":"ea753574-08b3-b402-808a-0e7ca34950ef"},{"name":"Delete action","id":"2dab6d10-770a-ea2c-6229-674efbfb48a9","request":{"method":"DELETE","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"url":"https://CLIENT_PANEL_ADDRESS/api/2/action/ACTION_KEY","description":"Parameter 'DATE\" could be replaced by date and hour of activity creation in format :
\nyyyy-mm-dd hh:mm:ss. This applies to historical provisioning of activities where impose of date from the past is required. With current activity addition parameter should be skipped what implies setting date and hour in format adequate to current Customer time zone.
In order to delete action you should send DELETE request to the URL: https://CLIENT_PANEL_ADDRESS/api/2/action/ACTION_KEY
\n\n","urlObject":{"protocol":"https","path":["api","2","action","ACTION_KEY"],"host":["CLIENT_PANEL_ADDRESS"],"query":[],"variable":[]}},"response":[{"id":"126ee741-97a8-ba46-14bf-2865036435e8","name":"Success","originalRequest":{"method":"DELETE","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"url":"https://CLIENT_PANEL_ADDRESS/api/2/action/ACTION_KEY"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"27","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Thu, 05 Oct 2017 07:10:40 GMT","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"l00ihorbl4lbstskjv8tk92og4","key":"PHPSESSID"}],"responseTime":"171","body":"{\"code\":200,\"message\":\"OK\"}"},{"id":"d849e446-a6e9-0709-6a00-729c7771d477","name":"Error-Not Found","originalRequest":{"method":"DELETE","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"url":"https://CLIENT_PANEL_ADDRESS/api/2/action/ACTION_KEY"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"49","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Thu, 05 Oct 2017 07:11:23 GMT","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"l00ihorbl4lbstskjv8tk92og4","key":"PHPSESSID"}],"responseTime":"136","body":"{\"code\":404,\"message\":\"Not Found\",\"errorCode\":12}"}],"_postman_id":"2dab6d10-770a-ea2c-6229-674efbfb48a9"}],"id":"7c7f58bc-4988-0eaf-4756-b1bd63cded02","_postman_id":"7c7f58bc-4988-0eaf-4756-b1bd63cded02","description":""},{"name":"Categories","item":[{"name":"Get all categories","id":"a752c178-b292-4619-571a-db24c069ec32","request":{"method":"GET","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"url":"https:/CLIENT_PANEL_ADDRESS/api/2/category","description":"Parameter
\nACTION_KEYshould be replaced with a name of an action key.
In order to get categories send GET request to the URL: https://CLIENT_PANEL_ADDRESS/api/2/category
In order to get all contacts in a given category send GET request to the URL: https://CLIENT_PANEL_ADDRESS/api/2/category/ID_CATEGORY/contact
\n\nParameter
\nID_CATEGORYshould be replaced with ID of a selected category.
In the case of large number of contacts assigned to a category, the system will respond with just the first page of 50 records. In order to see other pages it is necessary to define which page is to be displayed by adding link to parameter ?page=N where N corresponds to the number of the page, e.g.: https://CLIENT_PANEL_ADDRESS/api/2/category/ID_CATEGORY/contact?page=2
In order to get information on categories send GET request to the URL: https://CLIENT_PANEL_ADDRESS/api/2/category/ID_CATEGORY
\n\n","urlObject":{"protocol":"https","path":["api","2","category","ID_CATEGORY"],"host":["CLIENT_PANEL_ADDRESS"],"query":[],"variable":[]}},"response":[{"id":"a3012bca-be08-8fb5-f0eb-0effd16e4391","name":"Success","originalRequest":{"method":"GET","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"url":"https:/CLIENT_PANEL_ADDRESS/api/2/category/ID_CATEGORY"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Encoding","value":"gzip","description":""},{"key":"Content-Length","value":"81","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Wed, 04 Oct 2017 08:25:14 GMT","description":""},{"key":"Vary","value":"Accept-Encoding","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"l00ihorbl4lbstskjv8tk92og4","key":"PHPSESSID"}],"responseTime":"107","body":"{\n \"code\": 200,\n \"data\": {\n \"category\": {\n \"ID_CATEGORY\": \"CATEGORY_NAME\"\n }\n },\n \"message\": \"OK\"\n}"},{"id":"6b1e1617-0ba5-8f72-cff6-71d49af384b4","name":"Error-Not Found","originalRequest":{"method":"GET","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"url":"https://CLIENT_PANEL_ADDRESS/api/2/category/ID_CATEGORY"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"49","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Wed, 04 Oct 2017 08:26:20 GMT","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"l00ihorbl4lbstskjv8tk92og4","key":"PHPSESSID"}],"responseTime":"175","body":"{\"code\":404,\"message\":\"Not Found\",\"errorCode\":26}"}],"_postman_id":"9cb1ccb2-5ed4-11b1-837f-088de25a39b4"},{"name":"Edit selected category","id":"06514805-80fc-6bfd-4681-30d150b0dd96","request":{"method":"PUT","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"category[name]","value":"CATEGORY_NAME","description":"Parameter
\nID_CATEGORYshould be replaced with category’s ID.
New category name
\n","type":"text"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/category/ID_CATEGORY","description":"In order to edit selected category send PUT request to the URL: https://CLIENT_PANEL_ADDRESS/api/2/category/ID_CATEGORY
\n\nParameter
\nID_CATEGORYshould be replaced with ID’s category.
\n\n","urlObject":{"protocol":"https","path":["api","2","category","ID_CATEGORY"],"host":["CLIENT_PANEL_ADDRESS"],"query":[],"variable":[]}},"response":[{"id":"e8dced96-ce44-44f2-9404-867e32b3ed73","name":"Success","originalRequest":{"method":"PUT","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"","value":"","disabled":true}],"body":{"mode":"urlencoded","urlencoded":[{"key":"category[name]","value":"ALTER_NAME_FOR_CATEGORY","description":"Nowa nazwa kategorii","type":"text"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/category/ID_CATEGORY"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"39","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Wed, 04 Oct 2017 08:29:59 GMT","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"l00ihorbl4lbstskjv8tk92og4","key":"PHPSESSID"}],"responseTime":"150","body":"{\"code\":200,\"data\":true,\"message\":\"OK\"}"},{"id":"0c7f0e45-ab1e-ee00-2096-099a41df625b","name":"Error-Not Found","originalRequest":{"method":"PUT","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"category[name]","value":"ALTER_NAME_FOR_CATEGORY","description":"Nowa nazwa kategorii","type":"text"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/category/ID_CATEGORY"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"49","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Wed, 04 Oct 2017 08:31:00 GMT","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"l00ihorbl4lbstskjv8tk92og4","key":"PHPSESSID"}],"responseTime":"94","body":"{\"code\":404,\"message\":\"Not Found\",\"errorCode\":29}"}],"_postman_id":"06514805-80fc-6bfd-4681-30d150b0dd96"},{"name":"Add new categories","id":"e4ae1b7f-8d85-3d35-9d87-2dadeca2af26","request":{"method":"POST","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"name","value":"CATEGORY_NAME","description":"Parameter
\nCATEGORY NAMEshould be replaced with category’s new name.
Category name
\n","type":"text"},{"key":"parentId","value":"PARENT_CATEGORY_ID","description":"Parent category ID
\n","type":"text"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/category/ID_CATEGORY","description":"In order to add new categories send POST request to the URL: https://CLIENT_PANEL_ADDRESS/api/2/category
\n\nParameter
\nCATEGORY_NAMEshould be replaced with the name of added category.
\n\n","urlObject":{"protocol":"https","path":["api","2","category","ID_CATEGORY"],"host":["CLIENT_PANEL_ADDRESS"],"query":[],"variable":[]}},"response":[{"id":"0f563ae3-4ea5-239d-2fe0-e14190a433ef","name":"Success","originalRequest":{"method":"POST","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"name","value":"CATEGORY_NAME","description":"Nazwa kategorii","type":"text"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/category"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Encoding","value":"gzip","description":""},{"key":"Content-Length","value":"105","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Wed, 04 Oct 2017 07:59:59 GMT","description":""},{"key":"Vary","value":"Accept-Encoding","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"l00ihorbl4lbstskjv8tk92og4","key":"PHPSESSID"}],"responseTime":"196","body":"{\n \"code\": 201,\n \"data\": {\n \"category\": {\n \"id\": 32,\n \"name\": \"CATEGORY_NAME\",\n \"parentId\": false\n }\n },\n \"message\": \"Created\"\n}"},{"id":"f2472b8b-7061-930f-2f63-c33972c7ec17","name":"Success-PARENT_CATEGORY_ID","originalRequest":{"method":"POST","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"name","value":"CATEGORY_NAME","description":"Nazwa kategorii","type":"text"},{"key":"parentId","value":"PARENT_CATEGORY_ID","description":"ID kategorii nadrzędnej ","type":"text"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/category"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Encoding","value":"gzip","description":""},{"key":"Content-Length","value":"105","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Thu, 05 Oct 2017 11:05:33 GMT","description":""},{"key":"Vary","value":"Accept-Encoding","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"5ru4jlnfi6pmao3os1q84vnc45","key":"PHPSESSID"}],"responseTime":"299","body":"{\n \"code\": 201,\n \"data\": {\n \"category\": {\n \"id\": 38,\n \"name\": \"CATEGORY_NAME\",\n \"parentId\": \"PARENT_CATEGORY_ID\"\n }\n },\n \"message\": \"Created\"\n}"},{"id":"fa39c5b9-eef0-802e-5d91-678849d9fded","name":"Found - 302","originalRequest":{"method":"POST","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"","value":"","disabled":true}],"body":{"mode":"urlencoded","urlencoded":[{"key":"name","value":"CATEGORY_NAME","description":"Nazwa kategorii","type":"text"},{"key":"","value":"","type":"text","disabled":true}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/category"},"status":"Found","code":302,"_postman_previewlanguage":"json","header":[{"key":"Content-Encoding","value":"gzip","description":""},{"key":"Content-Length","value":"105","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Wed, 04 Oct 2017 08:01:23 GMT","description":""},{"key":"Vary","value":"Accept-Encoding","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"l00ihorbl4lbstskjv8tk92og4","key":"PHPSESSID"}],"responseTime":"179","body":"{\n \"code\": 302,\n \"data\": {\n \"category\": {\n \"id\": \"32\",\n \"name\": \"CATEGORY_NAME\",\n \"parentId\": null\n }\n },\n \"message\": \"Found\"\n}"}],"_postman_id":"e4ae1b7f-8d85-3d35-9d87-2dadeca2af26"},{"name":"Add new contacts to categories","id":"c126cdfc-e629-bdd1-3bb6-bd83934dcc72","request":{"method":"POST","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"contact[0]","value":"ID_CONTACT_1","type":"text"},{"key":"contact[1]","value":"ID_CONTACT_2","type":"text"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/category/ID_CATEGORY/contact","description":"Parameter
\nPARENT_CATEGORY_IDshould be replaced with ID of parent category.
In order to add new contacts to a category send POST request to the URL: https://CLIENT_PANEL_ADRESS/api/2/category/ID_CATEGORY/contact
\n\nParameter
\nID_CATEGORYshould be replaced with category’s ID.
\n\n","urlObject":{"protocol":"https","path":["api","2","category","ID_CATEGORY","contact"],"host":["CLIENT_PANEL_ADDRESS"],"query":[],"variable":[]}},"response":[{"id":"e7b68757-5843-bab9-6f67-1390b1de73cf","name":"Success","originalRequest":{"method":"POST","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"contact[0]","value":"ID_CONTACT_1","description":"Numer ID kontaktu","type":"text"},{"key":"contact[1]","value":"ID_CONTACT_2","description":"Numer ID kontaktu","type":"text"}]},"url":"https:/CLIENT_PANEL_ADDRESS/api/2/category/ID_CATEGORY/contact"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"44","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Wed, 04 Oct 2017 08:09:51 GMT","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"l00ihorbl4lbstskjv8tk92og4","key":"PHPSESSID"}],"responseTime":"202","body":"{\"code\":201,\"data\":true,\"message\":\"Created\"}"},{"id":"00aac3ae-85e8-dbf1-6e56-f8149440145b","name":"Error-Not Found","originalRequest":{"method":"POST","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"contact[0]","value":"ID_CONTACT_1","description":"Numer ID kontaktu","type":"text"},{"key":"contact[1]","value":"ID_CONTACT_2","description":"Numer ID kontaktu","type":"text"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/category/ID_CATEGORY/contact"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"49","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Thu, 05 Oct 2017 11:25:18 GMT","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"5ru4jlnfi6pmao3os1q84vnc45","key":"PHPSESSID"}],"responseTime":"101","body":"{\"code\":404,\"message\":\"Not Found\",\"errorCode\":26}"},{"id":"5168b949-4199-8dac-5aa1-56bbd5d238c4","name":"Error-Forbidden","originalRequest":{"method":"POST","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"contact[0]","value":"","type":"text"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/category/ID_CATEGORY/contact"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"49","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Wed, 04 Oct 2017 08:10:47 GMT","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"l00ihorbl4lbstskjv8tk92og4","key":"PHPSESSID"}],"responseTime":"137","body":"{\"code\":403,\"message\":\"Forbidden\",\"errorCode\":28}"}],"_postman_id":"c126cdfc-e629-bdd1-3bb6-bd83934dcc72"},{"name":"Delete many contacts from category","id":"caef8daa-dcb8-46c7-be82-0e282f6c6444","request":{"method":"POST","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"contact[0]","value":"ID_CONTACT_1","type":"text"},{"key":"contact[1]","value":"ID_CONTACT_2","type":"text"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/category/ID_CATEGORY/contact-remove","description":"Parameter
\nID_CONTACTshould be replaced with ID of a contact to whom the category is being assigned.
In order to delete many contacts from a category send POST request to the URL: https://CLIENT_PANEL_ADRESS/api/2/category/ID_CATEGORY/contact
\n\nParameter
\nID_CATEGORYshould be replaced with category’s ID.
\n\n","urlObject":{"protocol":"https","path":["api","2","category","ID_CATEGORY","contact-remove"],"host":["CLIENT_PANEL_ADDRESS"],"query":[],"variable":[]}},"response":[{"id":"c4781836-a5d1-47e5-8654-ffaf33bdcb8b","name":"Success","originalRequest":{"method":"POST","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"contact[0]","value":"ID_CONTACT_1","description":"Numer ID kontaktu","type":"text"},{"key":"contact[1]","value":"ID_CONTACT_2","description":"Numer ID kontaktu","type":"text"}]},"url":"https:/CLIENT_PANEL_ADDRESS/api/2/category/ID_CATEGORY/contact-remove"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"44","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Wed, 04 Oct 2017 08:09:51 GMT","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"l00ihorbl4lbstskjv8tk92og4","key":"PHPSESSID"}],"responseTime":"202","body":"{\"code\":201,\"data\":true,\"message\":\"Created\"}"},{"id":"ec526f2e-1ed4-433d-a153-faa48ee2cc6a","name":"Error-Forbidden","originalRequest":{"method":"POST","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"contact[0]","value":"","type":"text"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/category/ID_CATEGORY/contact-remove"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"49","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Wed, 04 Oct 2017 08:10:47 GMT","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"l00ihorbl4lbstskjv8tk92og4","key":"PHPSESSID"}],"responseTime":"137","body":"{\"code\":403,\"message\":\"Forbidden\",\"errorCode\":117}"}],"_postman_id":"caef8daa-dcb8-46c7-be82-0e282f6c6444"},{"name":"Delete contacts from a category","id":"3ea248a8-1439-403d-84a8-1f4f0ba963bf","request":{"method":"DELETE","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"url":"https://CLIENT_PANEL_ADRESS/api/2/category/ID_CATEGORY/contact/ID_CONTACT","description":"Parameter
\nID_CONTACTshould be replaced with ID of a contact to whom the category is being assigned.
In order to delete contacts from a category of a given ID send DELETE request to the URL: https://CLIENT_PANEL_ADRESS/api/2/category/ID_CATEGORY/contact/ID_CONTACT
\n\nParameter
\nID_CATEGORYshould be replaced with ID’s category.
\n\n","urlObject":{"protocol":"https","path":["api","2","category","ID_CATEGORY","contact","ID_CONTACT"],"host":["CLIENT_PANEL_ADRESS"],"query":[],"variable":[]}},"response":[{"id":"d5d6a80d-05df-2beb-1240-dc8c4683ad62","name":"Success","originalRequest":{"method":"DELETE","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"url":"https://CLIENT_PANEL_ADRESS/api/2/category/ID_CATEGORY/contact/ID_CONTACT"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"39","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Wed, 04 Oct 2017 08:22:18 GMT","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"l00ihorbl4lbstskjv8tk92og4","key":"PHPSESSID"}],"responseTime":"159","body":"{\"code\":200,\"data\":true,\"message\":\"OK\"}"},{"id":"924b44c8-25a4-909a-8a2a-6cea1ce45c0e","name":"Error-Not Found","originalRequest":{"method":"DELETE","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"url":"https://CLIENT_PANEL_ADRESS/api/2/category/ID_CATEGORY/contact/ID_CONTACT"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"34","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Wed, 04 Oct 2017 08:21:37 GMT","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"l00ihorbl4lbstskjv8tk92og4","key":"PHPSESSID"}],"responseTime":"97","body":"{\"code\":404,\"message\":\"Not Found\"}"}],"_postman_id":"3ea248a8-1439-403d-84a8-1f4f0ba963bf"},{"name":"Delete category","id":"aa04defc-cc1b-430e-a9ec-2f291bebab6f","request":{"method":"DELETE","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"formdata","formdata":[]},"url":"https://CLIENT_PANEL_ADRESS/api/2/category/ID_CATEGORY/contact/ID_CONTACT","description":"Parameter
\nID_CONTACTshould be replaced with contact’s ID.
In order to delete category send DELETE request to the URL: https://CLIENT_PANEL_ADDRESS/api/2/category/ID_CATEGORY
\n\n","urlObject":{"protocol":"https","path":["api","2","category","ID_CATEGORY","contact","ID_CONTACT"],"host":["CLIENT_PANEL_ADRESS"],"query":[],"variable":[]}},"response":[{"id":"bfbe44aa-db41-40a8-a774-b1da4e1e854b","name":"Success","originalRequest":{"method":"DELETE","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"url":"https://CLIENT_PANEL_ADRESS/api/2/category/ID_CATEGORY/contact/ID_CONTACT"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"39","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Wed, 04 Oct 2017 08:22:18 GMT","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"l00ihorbl4lbstskjv8tk92og4","key":"PHPSESSID"}],"responseTime":null,"body":"{\"code\":200,\"data\":true,\"message\":\"OK\"}"},{"id":"7f88c999-7884-4752-909a-9b907d05b01a","name":"Error-Not Found","originalRequest":{"method":"DELETE","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"url":"https://CLIENT_PANEL_ADRESS/api/2/category/ID_CATEGORY/contact/ID_CONTACT"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"34","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Wed, 04 Oct 2017 08:21:37 GMT","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"l00ihorbl4lbstskjv8tk92og4","key":"PHPSESSID"}],"responseTime":null,"body":"{\"code\":404,\"message\":\"Not Found\"}"}],"_postman_id":"aa04defc-cc1b-430e-a9ec-2f291bebab6f"}],"id":"0d2f0ca3-054b-2177-fa62-16b4da28aa63","_postman_id":"0d2f0ca3-054b-2177-fa62-16b4da28aa63","description":""},{"name":"Tags","item":[{"name":"Get information on tags","id":"2e263702-1307-ec06-2131-6ed822a9c741","request":{"method":"GET","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"url":"https://CLIENT_PANEL_ADDRESS/api/2/tag/ID_TAG","description":"Parameter
\nID_CATEGORYshould be replaced with ID’s category.
In order to get information on a tag send GET request to the URL: https://CLIENT_PANEL_ADDRESS/api/2/tag/ID_TAG
\n\n","urlObject":{"protocol":"https","path":["api","2","tag","ID_TAG"],"host":["CLIENT_PANEL_ADDRESS"],"query":[],"variable":[]}},"response":[{"id":"1a157600-11c8-c831-79ad-af7370308a32","name":"success","originalRequest":{"method":"GET","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"}],"url":"https://CLIENT_PANEL_ADDRESS/api/2/tag/ID_TAG"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"66","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Wed, 04 Oct 2017 10:17:32 GMT","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"5ru4jlnfi6pmao3os1q84vnc45","key":"PHPSESSID"}],"responseTime":"262","body":"{\n \"code\": 200,\n \"data\": {\n \"tag\": {\n \"ID_TAG\": \"TAG\"\n }\n },\n \"message\": \"OK\"\n}"},{"id":"52877414-57fb-172f-83b4-c863c9f63a00","name":"Error-Not Found","originalRequest":{"method":"GET","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"}],"url":"https://CLIENT_PANEL_ADDRESS/api/2/tag/ID_TAG"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"34","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Wed, 04 Oct 2017 10:18:26 GMT","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"5ru4jlnfi6pmao3os1q84vnc45","key":"PHPSESSID"}],"responseTime":"167","body":"{\"code\":404,\"message\":\"Not Found\"}"}],"_postman_id":"2e263702-1307-ec06-2131-6ed822a9c741"},{"name":"Get all contacts to tags","id":"c865f4cb-736b-e635-2ef2-f5c38c905b6a","request":{"method":"GET","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"url":"https://CLIENT_PANEL_ADDRESS/api/2/tag/ID_TAG/contact","description":"Parameter
\nID_TAGshould be replaced with ID of a given tag.
In order to get all contacts to a given tag send GET request to the URL: https://CLIENT_PANEL_ADDRESS/api/2/tag/ID_TAG/contact
\n\nParameter
\nID_TAGshould be replaced by ID of a given tag.
In the case of getting large number of contacts assigned to a tag, the system will respond with just the first page of 50 records. In order to see other pages it is necessary to define which page is to be displayed by adding link to parameter ?page=N where N corresponds to the number of the page, e.g.: https://CLIENT_PANEL_ADDRESS/api/2/tag/ID_TAG/contact?page=2
In order to get all tags send GET request to the URL: https://CLIENT_PANEL_ADDRESS/api/2/tag
In order to edit a tag send PUT request to the URL: https://CLIENT_PANEL_ADDRESS/api/2/tag/ID_TAG
\n\nParameter
\nID_TAGshould be replaced with ID of a given tag.
\n\n","urlObject":{"protocol":"https","path":["api","2","tag","ID_TAG"],"host":["CLIENT_PANEL_ADDRESS"],"query":[],"variable":[]}},"response":[{"id":"799d2c9c-3a1f-c513-3b27-21c1d369b413","name":"success","originalRequest":{"method":"PUT","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"tag[name]","value":"ALTER_NAME_FOR_TAG"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/tag/ID_TAG"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"39","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Wed, 04 Oct 2017 10:22:38 GMT","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"5ru4jlnfi6pmao3os1q84vnc45","key":"PHPSESSID"}],"responseTime":"698","body":"{\"code\":200,\"data\":true,\"message\":\"OK\"}"},{"id":"56d76a91-c14c-bde8-a8f2-18d1bd68e1b6","name":"error-Not Found","originalRequest":{"method":"PUT","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"tag[name]","value":"ALTER_NAME_FOR_TAG","type":"text"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/tag/ID_TAG"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"49","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Wed, 04 Oct 2017 10:23:41 GMT","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"5ru4jlnfi6pmao3os1q84vnc45","key":"PHPSESSID"}],"responseTime":"209","body":"{\"code\":404,\"message\":\"Not Found\",\"errorCode\":38}"}],"_postman_id":"f602b3ec-b28d-f961-0725-25de54f6c363"},{"name":"Add new tags","id":"a66f0be2-244c-fbd3-18b0-7b11e57895c3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"name","value":"TAG_NAME","type":"text"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/tag","description":"Parameter
\nTAG_NAMEshould be replaced with tag’s new name.
In order to add new tags send POST request to the URL: https://CLIENT_PANEL_ADDRESS/api/2/tag
\n\n","urlObject":{"protocol":"https","path":["api","2","tag"],"host":["CLIENT_PANEL_ADDRESS"],"query":[],"variable":[]}},"response":[{"id":"1abd768e-6d28-1faf-3bc3-f831a26fe4b6","name":"success","originalRequest":{"method":"POST","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"name","value":"TAG_NAME","type":"text"}]},"url":"https://CLIENT_PANEL_ADRDESS.pl/api/2/tag"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Encoding","value":"gzip","description":""},{"key":"Content-Length","value":"108","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Wed, 04 Oct 2017 09:34:25 GMT","description":""},{"key":"Vary","value":"Accept-Encoding","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"5ru4jlnfi6pmao3os1q84vnc45","key":"PHPSESSID"}],"responseTime":"255","body":"{\n \"code\": 201,\n \"data\": {\n \"tag\": {\n \"id\": 164,\n \"name\": \"TAG_NAME\",\n \"parentId\": false\n }\n },\n \"message\": \"Created\"\n}"},{"id":"c7186252-2a3d-2b43-cdb0-15dd2151e56f","name":"error-Not Found","originalRequest":{"method":"POST","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"url":"https://CLIENT_PANEL_ADDRESS/api/2/tag"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"49","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Wed, 04 Oct 2017 09:35:06 GMT","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"5ru4jlnfi6pmao3os1q84vnc45","key":"PHPSESSID"}],"responseTime":"156","body":"{\"code\":404,\"message\":\"Not Found\",\"errorCode\":31}"}],"_postman_id":"a66f0be2-244c-fbd3-18b0-7b11e57895c3"},{"name":"Add new contacts to a tag","id":"d134a6fb-5312-f69d-ea0a-3d2d8e7be617","request":{"method":"POST","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"contact[0]","value":"ID_CONTACT","type":"text"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/tag/ID_TAG/contact","description":"Parameter
\nTAG_NAMEshould be replaced with the name of the tag being added.
In order to add contacts to tags send POST request to the URL: https://CLIENT_PANEL_ADDRESS/api/2/tag/ID_TAG/contact
\n\nParameter
\nID_TAGshould be replaced with ID of a tag.
\n\n","urlObject":{"protocol":"https","path":["api","2","tag","ID_TAG","contact"],"host":["CLIENT_PANEL_ADDRESS"],"query":[],"variable":[]}},"response":[{"id":"25bfd64a-887f-ad16-9e11-a9b55f69d726","name":"success","originalRequest":{"method":"POST","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"contact[0]","value":"ID_CONTACT","type":"text"}]},"url":"https://CLIENT_PANEL_ADRESS/api/2/tag/ID_TAG/contact"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"44","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Wed, 04 Oct 2017 09:46:16 GMT","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"5ru4jlnfi6pmao3os1q84vnc45","key":"PHPSESSID"}],"responseTime":"300","body":"{\"code\":201,\"data\":true,\"message\":\"Created\"}"},{"id":"7c5c3414-4f39-fbbe-7c94-438aa58eb8d4","name":"error-Not Found","originalRequest":{"method":"POST","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"contact[0]","value":"ID_CONTACT","type":"text"}]},"url":"https://CLIENT_PANEL_ADRESS/api/2/tag/ID_TAG/contact"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"49","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Wed, 04 Oct 2017 09:47:33 GMT","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"5ru4jlnfi6pmao3os1q84vnc45","key":"PHPSESSID"}],"responseTime":"128","body":"{\"code\":404,\"message\":\"Not Found\",\"errorCode\":37}"}],"_postman_id":"d134a6fb-5312-f69d-ea0a-3d2d8e7be617"},{"name":"Delete contacts from a tag","id":"905217b1-2baf-0b89-ea79-27b54cc56823","request":{"method":"DELETE","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"url":"https://CLIENT_PANEL_ADDRESS/api/2/tag/ID_TAG/contact/ID_CONTACT","description":"Parameter
\nID_CONTACTshould be replaced with ID of the contact to which the tag is being assigned.
In order to delete contacts from a tag send DELETE request to the URL: https://CLIENT_PANEL_ADDRESS/api/2/tag/ID_TAG/contact/ID_CONTACT
\n\nParameter
\nID_TAGshould be replaced with ID of a given tag.
\n\n","urlObject":{"protocol":"https","path":["api","2","tag","ID_TAG","contact","ID_CONTACT"],"host":["CLIENT_PANEL_ADDRESS"],"query":[],"variable":[]}},"response":[{"id":"05081d23-5880-bda4-ed36-f11270475dfd","name":"success","originalRequest":{"method":"DELETE","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"url":"https://CLIENT_PANEL_ADDRESS/api/2/tag/ID_TAG/contact/ID_CONTACT"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"39","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Wed, 04 Oct 2017 10:11:52 GMT","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"5ru4jlnfi6pmao3os1q84vnc45","key":"PHPSESSID"}],"responseTime":"192","body":"{\"code\":200,\"data\":true,\"message\":\"OK\"}"},{"id":"2367470b-eb5d-fbcb-718e-e6e6640e6a31","name":"error-Not Found","originalRequest":{"method":"DELETE","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"url":"https://CLIENT_PANEL_ADRDESS/api/2/tag/ID_TAG/contact/ID_CONTACT"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"34","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Wed, 04 Oct 2017 10:12:45 GMT","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"5ru4jlnfi6pmao3os1q84vnc45","key":"PHPSESSID"}],"responseTime":"187","body":"{\"code\":404,\"message\":\"Not Found\"}"}],"_postman_id":"905217b1-2baf-0b89-ea79-27b54cc56823"},{"name":"Delete tag","id":"4079adaf-195e-43a1-8295-651c478064d7","request":{"method":"DELETE","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"formdata","formdata":[]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/tag/ID_TAG","description":"Parameter
\nID_CONTACTshould be replaced with contact’s ID.
In order to delete a tag send DELETE request to the URL: https://CLIENT_PANEL_ADDRESS/api/2/tag/ID_TAG
\n\n","urlObject":{"protocol":"https","path":["api","2","tag","ID_TAG"],"host":["CLIENT_PANEL_ADDRESS"],"query":[],"variable":[]}},"response":[{"id":"fc0fad71-14d5-4f21-a005-23bdce2313f8","name":"success","originalRequest":{"method":"DELETE","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/tag/ID_TAG"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"39","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Wed, 04 Oct 2017 10:11:52 GMT","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"5ru4jlnfi6pmao3os1q84vnc45","key":"PHPSESSID"}],"responseTime":null,"body":"{\"code\":200,\"data\":true,\"message\":\"OK\"}"},{"id":"fc17769d-5c0f-4b75-905a-8a3b433b7ac7","name":"error-Not Found","originalRequest":{"method":"DELETE","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"formdata","formdata":[]},"url":"https://CLIENT_PANEL_ADRDESS/api/2/tag/ID_TAG"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"34","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Wed, 04 Oct 2017 10:12:45 GMT","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"5ru4jlnfi6pmao3os1q84vnc45","key":"PHPSESSID"}],"responseTime":null,"body":"{\"code\":404,\"message\":\"Not Found\"}"}],"_postman_id":"4079adaf-195e-43a1-8295-651c478064d7"}],"id":"019fb2db-1912-7769-a828-2b41c666c421","event":[{"listen":"prerequest","script":{"id":"363d2b81-ec89-4340-9b21-8d606582c50d","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"7faf915e-4fc8-4730-acb6-cb248cfcf74c","type":"text/javascript","exec":[""]}}],"_postman_id":"019fb2db-1912-7769-a828-2b41c666c421","description":""},{"name":"Consents","item":[{"name":"Get all available consents","id":"713bccfc-702f-e2f2-ec4d-2f9188bb22ef","request":{"method":"GET","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"url":"https://CLIENT_PANEL_ADDRESS/api/2/agreement","description":"Parameter
\nID_TAGshould be replaced with ID of a given tag.
In order to get all the available consents send GET request to the URL: https://CLIENT_PANEL_ADDRESS/api/2/agreement
In order to get contacts assigned to an consent of a given ID or API key send GET request to the URL: https://CLIENT_PANEL_ADDRESS/api/2/agreement/AGREEMENT/contact
\n\nParameter
\nAGREEMENTshould be replaced with ID number or API key of a chosen consent.
In the case of getting large number of contacts assigned to an consent, the system will respond with just the first page of 50 records. In order to see other pages it is necessary to define which page is to be displayed by adding to the link the following parameter ?page=N where N corresponds to the number of the page, e.g.: https://CLIENT_PANEL_ADDRESS/api/2/agreement/AGREEMENT/contact?page=2
In order to get all the available consents in group send GET request to the URL: https://CLIENT_PANEL_ADDRESS/api/2/agreement/group/API_GROUP_KEY
\n\n","urlObject":{"protocol":"https","path":["api","2","agreement","group","API_GROUP_KEY"],"host":["CLIENT_PANEL_ADDRESS"],"query":[{"disabled":true,"key":"USER_AGENT","value":"iPresso"},{"disabled":true,"key":"","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"disabled":true,"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"variable":[]}},"response":[{"id":"34caf996-e846-4de8-8ff3-590e52e2a1b2","name":"Success","originalRequest":{"method":"GET","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"url":{"raw":"https://CLIENT_PANEL_ADDRESS/api/2/agreement/group/API_GROUP_KEY","protocol":"https","host":["CLIENT_PANEL_ADDRESS"],"path":["api","2","agreement","group","API_GROUP_KEY"],"query":[{"key":"USER_AGENT","value":"iPresso","disabled":true},{"key":"","value":"72d5b935a85b6e7366ddd0d3b6db14c9","disabled":true},{"key":"Content-Type","value":"application/x-www-form-urlencoded","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 28 Aug 2019 09:32:47 GMT"},{"key":"X-Powered-By","value":"PHP/7.0.25"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Referrer-Policy","value":"no-referrer-when-downgrade"},{"key":"X-XSS-Protection","value":"1"},{"key":"Content-Security-Policy","value":"default-src * 'unsafe-inline' 'unsafe-eval' data:; img-src * 'self' data: blob:;"},{"key":"X-Frame-Options","value":"deny"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"150"},{"key":"Content-Type","value":"text/json;charset=UTF-8"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"data\": {\n \"agreement\": {\n \"28\": {\n \"id\": 28,\n \"name\": \"AGREEMENT_NAME\",\n \"descr\": \"AGREEMENT_DESCRIPTION\",\n \"short_name\": \"AGREEMENT_SHORT_NAME\",\n \"cant_delete\": 1,\n \"required\": 0,\n \"dm_visible\": 1\n }\n }\n },\n \"message\": \"OK\"\n}"},{"id":"71583c3c-f371-49c6-a860-c90072c90cbe","name":"Error - 404","originalRequest":{"method":"GET","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"url":{"raw":"https://CLIENT_PANEL_ADDRESS/api/2/agreement/group/API_GROUP_KEY","protocol":"https","host":["CLIENT_PANEL_ADDRESS"],"path":["api","2","agreement","group","API_GROUP_KEY"],"query":[{"key":"USER_AGENT","value":"iPresso","disabled":true},{"key":"","value":"72d5b935a85b6e7366ddd0d3b6db14c9","disabled":true},{"key":"Content-Type","value":"application/x-www-form-urlencoded","disabled":true}]}},"status":"Not Found","code":404,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"code\": 404,\n \"message\": \"Not Found\"\n}"}],"_postman_id":"8daf6851-ca19-4be0-82a4-2c909c2068bd"},{"name":"Get available contacts","id":"b5e177f7-3aa1-4eaa-9054-fc8585ec96f3","request":{"method":"GET","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"formdata","formdata":[]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/agreement/stats/count?id_agreement / api_key=int/string&contact_type=string&group_by_consent=bool","description":"Parameter
\nAPI_GROUP_KEYshould be replaced with api key of a chosen consent group.
Resource: GET /agreement/stats/count
Retrieves the number of contacts for consents. Returns statistics regarding consents held by contacts.
\n\n\nParameter
\nid_agreement / api_key(Optional)
ID / API key of a specific consent. If provided, the response will return the count only for that consent.
\n\nParameter
\ncontact_type(Optional)
Returns the number of contacts only for a specific key (e.g., main_contact for individuals, other for companies).
\n\n","urlObject":{"protocol":"https","path":["api","2","agreement","stats","count"],"host":["CLIENT_PANEL_ADDRESS"],"query":[{"description":{"content":"Parameter
\ngroup_by_consent(Optional)
If set to 1, returns a summary of all consents along with their respective counts.
(Optional) ID / API key of a specific consent. If provided, it will return the count only for that consent.
\n","type":"text/plain"},"key":"id_agreement / api_key","value":"int/string"},{"description":{"content":"(Optional) Returns the number of contacts only for a specific key (e.g., main_contact for individuals, other for companies).
\n","type":"text/plain"},"key":"contact_type","value":"string"},{"description":{"content":"(Optional) If set to 1, returns a summary of all consents along with their counts.
\n","type":"text/plain"},"key":"group_by_consent","value":"bool"}],"variable":[]}},"response":[{"id":"8ccdf4b8-f221-4984-ab3d-c60d59ebf927","name":"Success","originalRequest":{"method":"GET","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"formdata","formdata":[]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/agreement/stats/count"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Encoding","value":"gzip","description":"","enabled":true},{"key":"Content-Length","value":"86","description":"","enabled":true},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":"","enabled":true},{"key":"Date","value":"Thu, 05 Oct 2017 10:01:31 GMT","description":"","enabled":true},{"key":"Vary","value":"Accept-Encoding","description":"","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","description":"","enabled":true}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"l00ihorbl4lbstskjv8tk92og4","key":"PHPSESSID"}],"responseTime":"188","body":"{\n \"code\": 200,\n \"data\": {\n \"count\": 250\n },\n \"message\": \"OK\"\n}"},{"id":"5acf2f54-7310-4136-a75b-7e7b38c2e389","name":"Success when id_agreement/api_key param given","originalRequest":{"method":"GET","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"formdata","formdata":[]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/agreement/stats/count"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Encoding","value":"gzip","description":"","enabled":true},{"key":"Content-Length","value":"86","description":"","enabled":true},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":"","enabled":true},{"key":"Date","value":"Thu, 05 Oct 2017 10:01:31 GMT","description":"","enabled":true},{"key":"Vary","value":"Accept-Encoding","description":"","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","description":"","enabled":true}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"l00ihorbl4lbstskjv8tk92og4","key":"PHPSESSID"}],"responseTime":"188","body":"{\n \"code\": 200,\n \"data\": {\n \"agreement\": {\n \"sample_api_key\": 250\n }\n },\n \"message\": \"OK\"\n}"},{"id":"fb1d6213-34c7-4556-9dca-933967ce5e3e","name":"Success when group_by_consent param given","originalRequest":{"method":"GET","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"formdata","formdata":[]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/agreement/stats/count"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Encoding","value":"gzip","description":"","enabled":true},{"key":"Content-Length","value":"86","description":"","enabled":true},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":"","enabled":true},{"key":"Date","value":"Thu, 05 Oct 2017 10:01:31 GMT","description":"","enabled":true},{"key":"Vary","value":"Accept-Encoding","description":"","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","description":"","enabled":true}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"l00ihorbl4lbstskjv8tk92og4","key":"PHPSESSID"}],"responseTime":"188","body":"{\n \"code\": 200,\n \"data\": {\n \"agreement\": {\n \"sample_api_key\": 200,\n \"sample_api_key_2\": 300,\n \"sample_api_key_3\": 400\n }\n },\n \"message\": \"OK\"\n}"}],"_postman_id":"b5e177f7-3aa1-4eaa-9054-fc8585ec96f3"},{"name":"Consent edition","id":"adee5614-ac9e-75a5-1095-d514198773e0","request":{"method":"PUT","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"agreement[name]","value":"AGREEMENT_NAME","description":"New consent name
\n"},{"key":"agreement[description]","value":"AGREEMENT_DESCRIPTION","description":"Consent content
\n"},{"key":"agreement[dmvisible]","value":"DM_VISIBLE_STATUS","description":"Parameter DM_VISIBLE_STATUS specifies whether an consent allows for sending messages: 0 if it doesn’t, 1 if it does.
Optional, validation for basic characters - according to what is in the panel - if not provided, a random value will be generated during creation and editing.
\n","type":"text"},{"key":"agreement[shortName]","value":"SHORT_NAME","description":"Optional, validation for standard characters.
\n","type":"text"},{"key":"agreement[shortContent]","value":"SHORT_CONTENT","description":"Optional description.
\n","type":"text"},{"key":"agreement[required]","value":"REQUIRED","description":"Allowed values are 0 and 1 - This information is used when retrieving the consent definition via the API and can be utilized accordingly.
\n","type":"text"},{"key":"agreement[anonymousCanMerge]","value":"ANONYMOUS_CAN_MERGE","description":"The parameter allows the merging of anonymous data. Permitted values are 0 and 1.
\n","type":"text"},{"key":"agreement[consentGroupApiKeys]","value":"CONSENT_GROUP_API_KEYS","description":"An array with API keys of consent groups to which the consent should belong (e.g., ['key_1', 'key_2']). If you do not want to edit the groups, do not provide it.
In order to edit consent send PUT request to the URL: https://CLIENT_PANEL_ADDRESS/api/2/agreement/AGREEMENT
\n\nParameter
\nAGREEMENTshould be replaced with ID number or API key of a chosen consent.
\n\nParameter
\nAGREEMENT_NAMEshould be replaced with the name of the new consent.
\n\nParameter
\nAGREEMENT_DESCRIPTIONshould be replaced with new content of the consent.
\n\n","urlObject":{"protocol":"https","path":["api","2","agreement","AGREEMENT"],"host":["CLIENT_PANEL_ADDRESS"],"query":[],"variable":[]}},"response":[{"id":"c1d4ec72-60be-1f69-1b7c-631953715b34","name":"Success","originalRequest":{"method":"PUT","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"name","value":"ALTER_AGREEMENT_NAME","description":"Nowa nazwa zgody marketingowej"},{"key":"description","value":"ALTER_AGREEMENT_DESCRIPTION","description":"Nowa treść zgody marketingowej"},{"key":"dmvisible","value":"DM_VISIBLE_STATUS","description":"Parametr `DM_VISIBLE_STATUS` określa czy zgoda zezwala na wysyłkę: 0 jeżeli nie zezwala, 1 jeżeli zezwala."},{"key":"apiKey","value":"API_KEY","description":"Optional, validation for basic characters - according to what is in the panel - if not provided, a random value will be generated during creation and editing.","type":"text"},{"key":"shortName","value":"SHORT_NAME","description":"Optional, validation for standard characters.","type":"text"},{"key":"shortContent","value":"SHORT_CONTENT","description":"Optional description.","type":"text"},{"key":"required","value":"REQUIRED","description":"Allowed values are 0 and 1 - This information is used when retrieving the consent definition via the API and can be utilized accordingly.","type":"text"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/agreement/AGREEMENT"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"39","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Wed, 04 Oct 2017 09:32:05 GMT","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"l00ihorbl4lbstskjv8tk92og4","key":"PHPSESSID"}],"responseTime":"324","body":"{\"code\":200,\"data\":true,\"message\":\"OK\"}"},{"id":"168a2c71-884b-9c47-3e87-dddd7c5285fb","name":"Error-Not Found","originalRequest":{"method":"PUT","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"name","value":"ALTER_AGREEMENT_NAME","description":"Nowa nazwa zgody marketingowej"},{"key":"description","value":"ALTER_AGREEMENT_DESCRIPTION","description":"Nowa treść zgody marketingowej"},{"key":"dmvisible","value":"DM_VISIBLE_STATUS","description":"Parametr `DM_VISIBLE_STATUS` określa czy zgoda zezwala na wysyłkę: 0 jeżeli nie zezwala, 1 jeżeli zezwala."},{"key":"apiKey","value":"API_KEY","description":"Optional, validation for basic characters - according to what is in the panel - if not provided, a random value will be generated during creation and editing.","type":"text"},{"key":"shortName","value":"SHORT_NAME","description":"Optional, validation for standard characters.","type":"text"},{"key":"shortContent","value":"SHORT_CONTENT","description":"Optional description.","type":"text"},{"key":"required","value":"REQUIRED","description":"Allowed values are 0 and 1 - This information is used when retrieving the consent definition via the API and can be utilized accordingly.","type":"text"}]},"url":"http://CLIENT_PANEL_ADDRESS/api/2/agreement/AGREEMENT"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"49","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Wed, 04 Oct 2017 09:34:35 GMT","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"l00ihorbl4lbstskjv8tk92og4","key":"PHPSESSID"}],"responseTime":"132","body":"{\"code\":404,\"message\":\"Not Found\",\"errorCode\":21}"}],"_postman_id":"adee5614-ac9e-75a5-1095-d514198773e0"},{"name":"Add new consents","id":"98b3b1ec-1053-37cf-1c74-98bdfbe7ac66","request":{"method":"POST","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"name","value":"AGREEMENT_NAME","description":"Parameter
\nDM_VISIBLE_STATUSspecifies whether an consent allows for sending messages: 0 if it doesn’t, 1 if it does.
Consent name
\n"},{"key":"description","value":"AGREEMENT_DESCRIPTION","description":"Consent content
\n"},{"key":"dmvisible","value":"DM_VISIBLE_STATUS","description":"Parameter DM_VISIBLE_STATUS specifies whether an consent allows for sending messages: 0 if it doesn’t, 1 if it does.
Optional, validation for basic characters - according to what is in the panel - if not provided, a random value will be generated during creation and editing.
\n","type":"text"},{"key":"shortName","value":"SHORT_NAME","description":"Optional, validation for standard characters.
\n","type":"text"},{"key":"shortContent","value":"SHORT_CONTENT","description":"Optional description.
\n","type":"text"},{"key":"required","value":"REQUIRED","description":"Allowed values are 0 and 1 - This information is used when retrieving the consent definition via the API and can be utilized accordingly.
\n","type":"text"},{"key":"anonymousCanMerge","value":"ANONYMOUS_CAN_MERGE","description":"The parameter allows the merging of anonymous data. Permitted values are 0 and 1.
\n","type":"text"},{"key":"consentGroupApiKeys","value":"CONSENT_GROUP_API_KEYS","description":"An array with API keys of consent groups to which the consent should belong (e.g., ['key_1', 'key_2']). If you do not want to edit the groups, do not provide it.
In order to add new consents send POST request to the URL: https://CLIENT_PANEL_ADDRESS/api/2/agreement
\n\nParameter
\nAGREEMENT_NAMEshould be replaced with the name of an consent.
\n\nParameter
\nAGREEMENT_DESCRIPTIONshould be replaced with the content of an consent.
\n\n","urlObject":{"protocol":"https","path":["api","2","agreement"],"host":["CLIENT_PANEL_ADDRESS"],"query":[],"variable":[]}},"response":[{"id":"2afac9b9-7cd9-9407-e1b9-4bd012f59400","name":"Success","originalRequest":{"method":"POST","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"name","value":"AGREEMENT_NAME","description":"Nazwa zgody marketingowej","type":"text"},{"key":"description","value":"AGREEMENT_DESCRIPTION","description":"Treść zgody marketingowej","type":"text"},{"key":"dmvisible","value":"0","type":"text"},{"key":"apiKey","value":"API_KEY","description":"Optional, validation for basic characters - according to what is in the panel - if not provided, a random value will be generated during creation and editing.","type":"text"},{"key":"shortName","value":"SHORT_NAME","description":"Optional, validation for standard characters.","type":"text"},{"key":"shortContent","value":"SHORT_CONTENT","description":"Optional description.","type":"text"},{"key":"required","value":"REQUIRED","description":"Allowed values are 0 and 1 - This information is used when retrieving the consent definition via the API and can be utilized accordingly.","type":"text"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/agreement"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Encoding","value":"gzip","description":""},{"key":"Content-Length","value":"118","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Wed, 04 Oct 2017 09:03:09 GMT","description":""},{"key":"Vary","value":"Accept-Encoding","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"l00ihorbl4lbstskjv8tk92og4","key":"PHPSESSID"}],"responseTime":"312","body":"{\n \"code\": 201,\n \"data\": {\n \"agreement\": {\n \"id\": 22,\n \"name\": \"AGREEMENT_NAME\",\n \"description\": \"AGREEMENT_DESCRIPTION\",\n \"dmvisible\": \"0\"\n \"apiKey\": \"API_KEY\"\n \"shortName\": \"SHORT_NAME\"\n \"shortContent\": \"SHORT_CONTENT\"\n \"required\": \"REQUIRED\"\n }\n },\n \"message\": \"Created\"\n}"},{"id":"229b250a-e2ce-66a5-2571-1d3069346e83","name":"Error-Found","originalRequest":{"method":"POST","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"name","value":"AGREEMENT_NAME","description":"Nazwa zgody marketingowej"},{"key":"description","value":"AGREEMENT_DESCRIPTION","description":"Treść zgody marketingowej"},{"key":"dmvisible","value":"0"},{"key":"apiKey","value":"API_KEY","description":"Optional, validation for basic characters - according to what is in the panel - if not provided, a random value will be generated during creation and editing.","type":"text"},{"key":"shortName","value":"SHORT_NAME","description":"Optional, validation for standard characters.","type":"text"},{"key":"shortContent","value":"SHORT_CONTENT","description":"Optional description.","type":"text"},{"key":"required","value":"REQUIRED","description":"Allowed values are 0 and 1 - This information is used when retrieving the consent definition via the API and can be utilized accordingly.","type":"text"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/agreement"},"status":"Found","code":302,"_postman_previewlanguage":"json","header":[{"key":"Content-Encoding","value":"gzip","description":""},{"key":"Content-Length","value":"110","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Wed, 04 Oct 2017 09:04:08 GMT","description":""},{"key":"Vary","value":"Accept-Encoding","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"l00ihorbl4lbstskjv8tk92og4","key":"PHPSESSID"}],"responseTime":"148","body":"{\n \"code\": 302,\n \"data\": {\n \"agreement\": {\n \"id\": 22,\n \"name\": \"AGREEMENT_NAME\",\n \"description\": \"AGREEMENT_DESCRIPTION\",\n \"dmvisible\": \"0\"\n \"apiKey\": \"API_KEY\"\n \"shortName\": \"SHORT_NAME\"\n \"shortContent\": \"SHORT_CONTENT\"\n \"required\": \"REQUIRED\"\n }\n },\n \"message\": \"Found\"\n}"}],"_postman_id":"98b3b1ec-1053-37cf-1c74-98bdfbe7ac66"},{"name":"Add contacts to consent","id":"2fd39a36-4df5-2c41-083c-ff969e47f334","request":{"method":"POST","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"contact[0]","value":"ID_CONTACT_1","type":"text"},{"key":"contact[1]","value":"ID_CONTACT_2","type":"text"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/agreement/AGREEMENT/contact","description":"Parameter
\nDM_VISIBLE_STATUSdefines whether consent allows sending message: 0 if it doesn’t, 1 if it does.
In order to add contacts to an consent of a chosen ID or API key send POST request to the URL: https://CLIENT_PANEL_ADDRESS/api/2/agreement/ID_AGREEMENT/contact
\n\nParameter
\nAGREEMENTshould be replaced with ID or API key number of a chosen consent.
\n\n","urlObject":{"protocol":"https","path":["api","2","agreement","AGREEMENT","contact"],"host":["CLIENT_PANEL_ADDRESS"],"query":[],"variable":[]}},"response":[{"id":"8e4210ac-0e2a-ad79-cdeb-d76ec5a652c5","name":"Success","originalRequest":{"method":"POST","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"contact[0]","value":"ID_CONTACT_1","description":"ID kontaktu 1"},{"key":"contact[1]","value":"ID_CONTACT_2","description":"ID kontaktu 2"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/agreement/AGREEMENT/contact"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"44","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Wed, 04 Oct 2017 09:42:46 GMT","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"l00ihorbl4lbstskjv8tk92og4","key":"PHPSESSID"}],"responseTime":"166","body":"{\"code\":201,\"data\":true,\"message\":\"Created\"}"},{"id":"9aa39da9-fd4a-252b-ae21-6a814fafe890","name":"Error-Forbidden","originalRequest":{"method":"POST","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"contact[0]","value":"ID_CONTACT_1","description":"ID kontaktu 1"},{"key":"contact[1]","value":"ID_CONTACT_2","description":"ID kontaktu 2"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/agreement/AGREEMENT/contact"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"49","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Wed, 04 Oct 2017 09:43:50 GMT","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"l00ihorbl4lbstskjv8tk92og4","key":"PHPSESSID"}],"responseTime":"188","body":"{\"code\":403,\"message\":\"Forbidden\",\"errorCode\":20}"}],"_postman_id":"2fd39a36-4df5-2c41-083c-ff969e47f334"},{"name":"Delete consent","id":"9324847c-c811-3d3e-7907-e810632ec44e","request":{"method":"DELETE","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"url":"https://CLIENT_PANEL_ADDRESS/api/2/agreement/AGREEMENT","description":"Parameter
\nID_CONTACTshould be replaced with ID number of a chosen contact.
In order to delete consent send DELETE request to the URL: https://CLIENT_PANEL_ADDRESS/api/2/agreement/AGREEMENT
\n\nParameter
\nAGREEMENTshould be replaced with ID or API key number of a chosen consent.
This operation may be performed only if the consent hasn’t been assigned to any contact.
\n","urlObject":{"protocol":"https","path":["api","2","agreement","AGREEMENT"],"host":["CLIENT_PANEL_ADDRESS"],"query":[],"variable":[]}},"response":[{"id":"0c98b3c5-ee78-7903-ee2c-80a1da798781","name":"Success","originalRequest":{"method":"DELETE","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"url":"https://CLIENT_PANEL_ADDRESS/api/2/agreement/AGREEMENT"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"39","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Wed, 04 Oct 2017 09:37:56 GMT","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"l00ihorbl4lbstskjv8tk92og4","key":"PHPSESSID"}],"responseTime":"235","body":"{\"code\":200,\"data\":true,\"message\":\"OK\"}"},{"id":"f1a3c663-05b6-001b-6d4c-a4eebc023853","name":"Error-Not Found","originalRequest":{"method":"DELETE","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"url":"https://CLIENT_PANEL_ADDRESS/api/2/agreement/AGREEMENT"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"49","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Wed, 04 Oct 2017 09:38:45 GMT","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"l00ihorbl4lbstskjv8tk92og4","key":"PHPSESSID"}],"responseTime":"139","body":"{\"code\":404,\"message\":\"Not Found\",\"errorCode\":21}"}],"_postman_id":"9324847c-c811-3d3e-7907-e810632ec44e"},{"name":"Delete contact’s consent","id":"4f402c2d-902e-a127-5e75-3b8ecfda9980","request":{"method":"DELETE","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"formdata","formdata":[]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/agreement/AGREEMENT/contact/CONTACT","description":"In order to delete contacts assigned to the consent of a chosen ID or API key send DELETE request to the URL: https://CLIENT_PANEL_ADDRESS/api/2/agreement/AGREEMENT/contact/ID_CONTACT
\n\nParameter
\nAGREEMENTshould be replaced with ID number or API key of a chosen consent.
\n\n","urlObject":{"protocol":"https","path":["api","2","agreement","AGREEMENT","contact","CONTACT"],"host":["CLIENT_PANEL_ADDRESS"],"query":[],"variable":[]}},"response":[{"id":"49f30d93-9b05-8974-9562-13d77e0b8b9d","name":"Success","originalRequest":{"method":"DELETE","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"","value":"","type":"text","disabled":true}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/agreement/AGREEMENT/contact/CONTACT"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"39","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Fri, 06 Oct 2017 08:37:14 GMT","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"l00ihorbl4lbstskjv8tk92og4","key":"PHPSESSID"}],"responseTime":"185","body":"{\"code\":200,\"data\":true,\"message\":\"OK\"}"},{"id":"e0777ac4-6f22-7ef8-d5f7-c45ae2c9dc0c","name":"Error-Forbidden","originalRequest":{"method":"DELETE","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"","value":"","type":"text","disabled":true}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/agreement/AGREEMENT/contact/CONTACT"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"49","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Fri, 06 Oct 2017 08:38:19 GMT","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"l00ihorbl4lbstskjv8tk92og4","key":"PHPSESSID"}],"responseTime":"121","body":"{\"code\":403,\"message\":\"Forbidden\",\"errorCode\":62}"}],"_postman_id":"4f402c2d-902e-a127-5e75-3b8ecfda9980"}],"id":"874851e2-9e19-a8c7-656f-5376ee7d51ea","event":[{"listen":"prerequest","script":{"id":"8223dc3b-ecfd-4d52-aa94-3647591095d7","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"91b2d729-ef40-4660-b212-537931437f39","type":"text/javascript","exec":[""]}}],"_postman_id":"874851e2-9e19-a8c7-656f-5376ee7d51ea","description":""},{"name":"Types","item":[{"name":"Get contacts of a given type","id":"0b897b39-bed2-f8c5-5b12-3202477fb973","request":{"method":"GET","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"formdata","formdata":[]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/type/ID_TYPE/contact","description":"Parameter
\nID_CONTACTshould be replaced with ID number of a chosen contact.
In order to get contacts of a given type send GET request to the URL: https://CLIENT_PANEL_ADDRESS/api/2/type/ID_TYPE/contact
\n\nParameter
\nID_CONTACTshould be replaced with contact’s ID.
\n\nParameter
\nID_TYPEshould be replaced with ID of a type.
In the case of getting large number of contacts assigned to types, the system will respond with just the first page of 50 records. In order to see other pages it is necessary to define which page is to be displayed by adding to the link parameter ?page=N where N corresponds to the number of the page, e.g.: https://CLIENT_PANEL_ADDRESS/api/2/type/ID_TYPE/contact?page=2
In order to get contact types send GET request to the URL: https://CLIENT_PANEL_ADDRESS/api/2/type
Resource: GET /contact/stats/count
This resource returns information about the number of contacts in the database, allowing for precise filtering by contact type keys.
\n\n\nParameter
\ncontact_type(Optional): Returns the number of contacts for a specific key only (e.g., main_contact for individuals, other for companies).
\n\n","urlObject":{"protocol":"https","path":["api","2","contact","stats","count"],"host":["CLIENT_PANEL_ADDRESS"],"query":[{"description":{"content":"Parameter
\ngroup_by_type(Optional): If set to 1, the API returns an array broken down by all available types, indexed by their keys.
(Optional) Returns the number of contacts only for a specific key (e.g., main_contact for individuals, other for companies).
\n","type":"text/plain"},"key":"contact_type","value":"string"},{"description":{"content":"(Optional) If set to 1, the API will return an array broken down by all available types according to their keys.
\n","type":"text/plain"},"key":"group_by_type","value":"bool"}],"variable":[]}},"response":[{"id":"06eae6a2-9b17-43cf-93af-76c01fcd0719","name":"Success","originalRequest":{"method":"GET","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"formdata","formdata":[]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/contact/stats/count"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Encoding","value":"gzip","description":"","enabled":true},{"key":"Content-Length","value":"86","description":"","enabled":true},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":"","enabled":true},{"key":"Date","value":"Thu, 05 Oct 2017 10:01:31 GMT","description":"","enabled":true},{"key":"Vary","value":"Accept-Encoding","description":"","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","description":"","enabled":true}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"l00ihorbl4lbstskjv8tk92og4","key":"PHPSESSID"}],"responseTime":"188","body":"{\n \"code\": 200,\n \"data\": {\n \"count\": 299232\n },\n \"message\": \"OK\"\n}"},{"id":"e111a32b-4308-44a0-adda-32542e4ac3ae","name":"Success when contact_type param given","originalRequest":{"method":"GET","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"formdata","formdata":[]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/contact/stats/count"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Encoding","value":"gzip","description":"","enabled":true},{"key":"Content-Length","value":"86","description":"","enabled":true},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":"","enabled":true},{"key":"Date","value":"Thu, 05 Oct 2017 10:01:31 GMT","description":"","enabled":true},{"key":"Vary","value":"Accept-Encoding","description":"","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","description":"","enabled":true}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"l00ihorbl4lbstskjv8tk92og4","key":"PHPSESSID"}],"responseTime":"188","body":"{\n \"code\": 200,\n \"data\": {\n \"type\": {\n \"sample_contact_type_key\": 9\n }\n },\n \"message\": \"OK\"\n}"},{"id":"14547a73-88e7-4b76-9959-9bf4366e9603","name":"Success when group_by_type param given","originalRequest":{"method":"GET","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"formdata","formdata":[]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/contact/stats/count"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Encoding","value":"gzip","description":"","enabled":true},{"key":"Content-Length","value":"86","description":"","enabled":true},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":"","enabled":true},{"key":"Date","value":"Thu, 05 Oct 2017 10:01:31 GMT","description":"","enabled":true},{"key":"Vary","value":"Accept-Encoding","description":"","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","description":"","enabled":true}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"l00ihorbl4lbstskjv8tk92og4","key":"PHPSESSID"}],"responseTime":"188","body":"{\n \"code\": 200,\n \"data\": {\n \"type\": {\n \"sample_contact_type_key_1\": 9,\n \"sample_contact_type_key_2\": 12,\n \"sample_contact_type_key_3\": 20\n }\n },\n \"message\": \"OK\"\n}"}],"_postman_id":"403389f6-b75f-4df6-9a2f-10a90d4b8468"},{"name":"Add new type of contact","id":"0a029b3b-45ce-6c98-f040-ba4934242255","request":{"method":"POST","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"key","value":"TYPE_KEY","description":"Name of type key
\n","type":"text"},{"key":"name","value":"TYPE_NAME","description":"Type name
\n","type":"text"},{"key":"parent","value":"TYPE_PARENT","description":"API type key to connect
\n","type":"text"},{"key":"attribute[0]","value":"ATTRIBUTE_KEY","description":"Attribute key
\n","type":"text"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/type","description":"In order to add new type of contact send POST request to the URL: https://CLIENT_PANEL_ADDRESS/api/2/type
\n\nParameter
\nTYPE_KEYshould be replaced with name of type key.
\n\nParameter
\nTYPE_NAMEshould be replaced with type name.
\n\nParameter
\nTYPE_PARENTshould be replaced with API type key to connect.
\n\n","urlObject":{"protocol":"https","path":["api","2","type"],"host":["CLIENT_PANEL_ADDRESS"],"query":[],"variable":[]}},"response":[{"id":"923862da-304f-babc-c9d6-60eb851bc30b","name":"Success","originalRequest":{"method":"POST","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"key","value":"TYPE_KEY","description":"Nazwa klucza typu"},{"key":"value","value":"TYPE_NAME","description":"Nazwa typu"},{"key":"attribute[0]","value":"ATTRIBUTE_KEY","description":"Klucz atrybutu"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/type"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Encoding","value":"gzip","description":""},{"key":"Content-Length","value":"122","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Thu, 05 Oct 2017 07:55:28 GMT","description":""},{"key":"Vary","value":"Accept-Encoding","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"l00ihorbl4lbstskjv8tk92og4","key":"PHPSESSID"}],"responseTime":"186","body":"{\n \"code\": 201,\n \"data\": {\n \"type\": {\n \"name\": \"TYPE_NAME\",\n \"key\": \"TYPE_KEY\",\n \"attribute\": {\n \"name\": {\n \"id\": \"18\",\n \"dict_name\": \"name\",\n \"attr_key\": \"name\"\n }\n }\n }\n },\n \"message\": \"Created\"\n}"},{"id":"60564069-ee7d-045c-8187-839a0dd29cac","name":"Error-Not Found","originalRequest":{"method":"POST","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"key","value":"TYPE_KEY","description":"Nazwa klucza typu"},{"key":"value","value":"TYPE_NAME","description":"Nazwa typu"},{"key":"attribute[0]","value":"ATTRIBUTE_KEY","description":"Klucz atrybutu"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/type"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"49","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Thu, 05 Oct 2017 07:53:11 GMT","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"l00ihorbl4lbstskjv8tk92og4","key":"PHPSESSID"}],"responseTime":"154","body":"{\"code\":404,\"message\":\"Not Found\",\"errorCode\":40}"}],"_postman_id":"0a029b3b-45ce-6c98-f040-ba4934242255"},{"name":"Assigne contact type to a contact","id":"e73b662d-8559-3c46-461a-5d0241e18bcc","request":{"method":"POST","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"contact[0]","value":"ID_CONTACT","description":"Parameter
\nATTRIBUTE_KEYshould be replaced with attribute key.
Contact ID number
\n"},{"key":"contact[1]","value":"ID_CONTACT","description":"Contact ID number
\n"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/type/TYPE_KEY/contact","description":"In order to assign contact type to a contact send POST request to the URL: https://CLIENT_PANEL_ADDRESS/api/2/type/TYPE_KEY/contact
\n\nParameter
\nTYPE_KEYshould be replaced with a type key.
\n\n","urlObject":{"protocol":"https","path":["api","2","type","TYPE_KEY","contact"],"host":["CLIENT_PANEL_ADDRESS"],"query":[],"variable":[]}},"response":[{"id":"8f7648c6-1ff7-83c7-7394-1aad587f640d","name":"Success","originalRequest":{"method":"POST","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"contact[0]","value":"ID_CONTACT","description":"Numer ID kontaktu","type":"text"},{"key":"contact[1]","value":"ID_CONTACT","description":"Numer ID kontaktu","type":"text"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/type/type/TYPE_KEY/contact"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"56","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Thu, 05 Oct 2017 08:02:12 GMT","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"l00ihorbl4lbstskjv8tk92og4","key":"PHPSESSID"}],"responseTime":"285","body":"{\"code\":200,\"data\":true,\"message\":\"Contact type edited\"}"},{"id":"1fcafcf9-9816-e40d-bb7f-2aa07aa44433","name":"Error-Not Found","originalRequest":{"method":"POST","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"contact[0]","value":"ID_CONTACT","description":"Numer ID kontaktu","type":"text"},{"key":"contact[1]","value":"ID_CONTACT","description":"Numer ID kontaktu","type":"text"}]},"url":"https://CLIENT_PANEL_ADDRESSl/api/2/type/TYPE_KEY/contact"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"49","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Thu, 05 Oct 2017 08:02:31 GMT","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"l00ihorbl4lbstskjv8tk92og4","key":"PHPSESSID"}],"responseTime":"110","body":"{\"code\":404,\"message\":\"Not Found\",\"errorCode\":43}"}],"_postman_id":"e73b662d-8559-3c46-461a-5d0241e18bcc"}],"id":"4e0d5c3a-115b-3390-f4ef-bb40dbeea9c0","_postman_id":"4e0d5c3a-115b-3390-f4ef-bb40dbeea9c0","description":""},{"name":"Searching contacts","item":[{"name":"Searching contacts by criteria","id":"ceb17f10-9ea3-2533-1756-16ec50b533fc","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"contact[email]","value":"EMAIL","type":"text"},{"key":"contact[fname]","value":"FIRST_NAME","type":"text"},{"key":"contact[lname]","value":"LAST_NAME","type":"text"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/contact/search","description":"Parameter
\nID_CONTACTshould be replaced with contact’s ID.
In order to search for a contact send POST request to the URL: https://CLIENT_PANEL_ADDRESS/api/2/contact/search
The following table shows all possible search criteria:
\n\n\nParameter
\n
\n\nParameter
\nFIRST_NAMEshould be replaced with the first name of the contact.
\n\n","urlObject":{"protocol":"https","path":["api","2","contact","search"],"host":["CLIENT_PANEL_ADDRESS"],"query":[],"variable":[]}},"response":[{"id":"33c9c133-dffe-3569-9307-25e3dd5ae404","name":"success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"contact[email]","value":"EMAIL"},{"key":"contact[fname]","value":"FIRST_NAME"},{"key":"contact[lname]","value":"LAST_NAME"}]},"url":"https://CLIENT_PANEL_ADRESS/api/2/contact/search"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"57","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Thu, 05 Oct 2017 06:52:35 GMT","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"5ru4jlnfi6pmao3os1q84vnc45","key":"PHPSESSID"}],"responseTime":"221","body":"{\n \"code\": 200,\n \"data\": {\n \"contact\": [\n \"ID_CONTACT\"\n ]\n },\n \"message\": \"OK\"\n}"},{"id":"38c64087-6acb-aa53-6c60-4cc58324bf98","name":"error-Not Found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"contact[email]","value":"EMAIL"},{"key":"contact[fname]","value":"FIRST_NAME"},{"key":"contact[lname]","value":"LAST_NAME"}]},"url":"https://CLIENT_PANEL_ADRESS/api/2/contact/search"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Encoding","value":"gzip","description":""},{"key":"Content-Length","value":"85","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Thu, 05 Oct 2017 06:53:38 GMT","description":""},{"key":"Vary","value":"Accept-Encoding","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"5ru4jlnfi6pmao3os1q84vnc45","key":"PHPSESSID"}],"responseTime":"160","body":"{\"code\":404,\"data\":{\"contact\":[]},\"message\":\"Not Found\",\"errorCode\":3}"}],"_postman_id":"ceb17f10-9ea3-2533-1756-16ec50b533fc"},{"name":"Extended search for contacts by criteria","id":"054b46c2-466c-9dd3-b8d6-a0947512e158","request":{"method":"POST","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"contact[email]","value":"EMAIL","type":"text"},{"key":"contact[fname]","value":"FIRST_NAME"},{"key":"contact[lname]","value":"LAST_NAME","type":"text"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/contact/search/extended","description":"Parameter
\nLAST_NAMEshould be replaced with the last name of the contact.
In order to search for a contact send POST request to the URL:\nhttps://CLIENT_PANEL_ADDRESS/api/2/contact/search/extended
The following table shows all possible search criteria:
\n\n\nParameter
\n
\n\nParameter
\nFIRST_NAMEshould be replaced with the first name of the contact.
\n\n","urlObject":{"protocol":"https","path":["api","2","contact","search","extended"],"host":["CLIENT_PANEL_ADDRESS"],"query":[],"variable":[]}},"response":[{"id":"1dd3085b-31dc-5dd0-41cd-f87aec18a1c9","name":"Success-User Not Found","originalRequest":{"method":"POST","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"contact[email]","value":"EMAIL","type":"text"},{"key":"contact[fname]","value":"FIRST_NAME"},{"key":"contact[lname[","value":"LAST_NAME","type":"text"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/contact/search/extended"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Encoding","value":"gzip","description":""},{"key":"Content-Length","value":"90","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Thu, 05 Oct 2017 12:44:29 GMT","description":""},{"key":"Vary","value":"Accept-Encoding","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"l00ihorbl4lbstskjv8tk92og4","key":"PHPSESSID"}],"responseTime":"123","body":"{\"code\":200,\"data\":{\"contact\":[],\"total\":\"0\",\"pages\":0,\"page\":1},\"message\":\"OK\"}"},{"id":"e367e331-de0e-5d76-b5a0-47386eee9110","name":"Success","originalRequest":{"method":"POST","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"contact[fname]","value":"EMAIL"},{"key":"contact[email]","value":"FIRST_NAME","type":"text"},{"key":"contact[lname]","value":"LAST_NAME","type":"text"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/contact/search/extended"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":"0","body":"{\n \"code\": 200,\n \"data\": {\n \"contact\": [\n{\n \"idContact\": 306144,\n \"fname\": \"FIRST_NAME\",\n \"lname\": \"LAST_NAME\",\n \"vocative\": \"vocative\",\n \"name\": \"\",\n \"email\": \"email@ipresso.com\",\n \"invalidEmail\": \"0\",\n \"phone\": \"\",\n \"mobile\": \"123456789\",\n \"postCode\": \"\",\n \"street\": \"\",\n \"buildingNumber\": \"\",\n \"flatNumber\": \"\",\n \"city\": false,\n \"country\": false,\n \"www\": \"\",\n \"workPosition\": \"\",\n \"company\": \"\",\n \"createDate\": \"2017-10-02 12:08:37\",\n \"modifyTime\": \"2017-10-02 12:39:18\",\n \"leadScoring\": false,\n \"type\": false,\n \"agreement\": {\n \"1\": \"Consent to receive marketing information\"\n},\n \"category\": [],\n \"tag\": {\n \"158\": \"ID_TAG\",\n \"162\": \"TAG_NAME\"\n},\n \"contactMonitoringIframe\": \"\",\n \"monitoringLink\": \"https://CLIENT_PANEL_ADRESS/contactcookie/EVwnRbQinHfCM37xi8pzskavaVXR3jhGKA-sD9De9k8./f3f55e0b03085bc178512783120c6134\",\n \"monitoringPixel\": \"https://CLIENT_PANEL_ADRESS/systemnc/contactcookiepixel/EVwnRbQinHfCM37xi8pzskavaVXR3jhGKA-sD9De9k8./f3f55e0b03085bc178512783120c6134.png\",\n \"hashIdContact\":\"EVwnRbQinHfCM37xi8pzskavaVXR3jhGKA-sD9De9k8.\",\n \"contactAccess\": []\n},\n],\n \"total\": \"1\",\n \"pages\": 1,\n \"page\": 1\n},\n \"message\": \"OK\"\n}"}],"_postman_id":"054b46c2-466c-9dd3-b8d6-a0947512e158"}],"id":"595f913b-5410-e674-ab74-e9fb63ee1e2b","event":[{"listen":"prerequest","script":{"id":"2c14511e-67ab-476e-8eee-df3138e90a86","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"bb0e41e6-d35b-4de2-9cde-26ca683b7054","type":"text/javascript","exec":[""]}}],"_postman_id":"595f913b-5410-e674-ab74-e9fb63ee1e2b","description":""},{"name":"Segmentation","item":[{"name":"Adding contacts to segments created by API","id":"88474f25-6bee-338b-42d2-32d98b9e4634","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"ipresso-external-key","value":"ExternalID","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"contact_origin","value":"1","description":"Parameter
\nLAST_NAMEshould be replaced with the last name of the contact.
Origin of contact's
\n","type":"text"},{"key":"contacts[0]","value":"ID_CONTACT_1","description":"E-mail or contact's ID's
\n","type":"text"},{"key":"contacts[1]","value":"ID_CONTACT_2","type":"text"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/segmentation/ID_SEGMENTATION/contact","description":"In order to add new segmentation via iPresso API POST request should be sent to the URL: https://CLIENT_PANEL_ADDRESS/api/2/segmentation/ID_SEGMENTATION/contact.
\n\nParameter
\nID_SEGMENTATIONneeds to be replaced with an ID of segmentation to which you want to add contacts.
Adding contacts to segment via API is possible only for segments created by API.
\n\n\nParameter
\ncontact_originmarks the origin of contacts. If you want to add contacts to segment by their IDs or external IDs, parametercontact_originshould be set to 1, if by contact hash values to 3 and if by their e-mail addresses, to 2.
\n\nParameter
\ncontact_typeis optional. Only contacts with given e-mail addresses and contact type will be added to the segment if you define this parameter. ValueTYPE_KEYneeds to be replaced by the API key of specific contact type.
In order do add contacts using their external ID, the ipresso-external-key parameter should be passed in the header.
\n\nParameter
\nipresso-external-keyis an optional parameter. It adopts the values of external ID groups defined in iPresso.
Array contacts needs to contain only e-mail addresses, ID or external ID depending on defined earlier contact_origin parameter.
It is possible to send only up to 1000 contacts in one request.
\n","urlObject":{"protocol":"https","path":["api","2","segmentation","ID_SEGMENTATION","contact"],"host":["CLIENT_PANEL_ADDRESS"],"query":[],"variable":[]}},"response":[{"id":"0071b1ff-b5e0-418d-fb14-3bfa3be4fb93","name":"Success-by ID","originalRequest":{"method":"POST","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"contact_origin","value":"1","description":"Typ przekazywanych kontatków","type":"text"},{"key":"contacts[0]","value":"306154","description":"E-mail lub ID kontaktu","type":"text"},{"key":"contacts[1]","value":"306153","description":"E-mail lub ID kontaktu","type":"text"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/segmentation/ID_SEGMENTATION/contact"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Encoding","value":"gzip","description":""},{"key":"Content-Length","value":"91","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Thu, 05 Oct 2017 10:03:32 GMT","description":""},{"key":"Vary","value":"Accept-Encoding","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"l00ihorbl4lbstskjv8tk92og4","key":"PHPSESSID"}],"responseTime":"144","body":"{\"code\":201,\"data\":{\"id\":\"438\",\"contacts_in_segment\":2},\"message\":\"Created\"}"},{"id":"2b26303b-82ad-dcd8-bd04-e1156605b787","name":"Success-By Email","originalRequest":{"method":"POST","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"contact_origin","value":"2","description":"Typ przekazywanych kontaktów","type":"text"},{"key":"contacts[0]","value":"test1@test.com","description":"E-mail lub ID kontaktu","type":"text"},{"key":"contacts[1]","value":"test2@test.com","description":"E-mail lub ID kontatku","type":"text"}]},"url":"https://CLIENT_PANEL_ADDRESS.pl/api/2/segmentation/ID_SEGMENTATION/contact"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Encoding","value":"gzip","description":""},{"key":"Content-Length","value":"90","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Thu, 05 Oct 2017 10:07:35 GMT","description":""},{"key":"Vary","value":"Accept-Encoding","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"l00ihorbl4lbstskjv8tk92og4","key":"PHPSESSID"}],"responseTime":"173","body":"{\"code\":201,\"data\":{\"id\":\"438\",\"contacts_in_segment\":4},\"message\":\"Created\"}"},{"id":"bdc93155-de81-1430-42aa-e41c110723da","name":"Success-By Hash","originalRequest":{"method":"POST","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"name","value":"Name","description":"Nazwa segmentu","type":"text"},{"key":"live_time","value":"2","type":"text"},{"key":"contact_origin","value":"3","description":"Typ przekazywanych kontaktów","type":"text"},{"key":"contacts[0]","value":"XwQqEsfTJSkSydkgNU0VoEevc8MeD8fLj1CiF9M1OMo","description":"hashID","type":"text"},{"key":"","value":"","type":"text","disabled":true}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/segmentation/"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Encoding","value":"gzip","description":""},{"key":"Content-Length","value":"88","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Thu, 05 Oct 2017 10:14:26 GMT","description":""},{"key":"Vary","value":"Accept-Encoding","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"l00ihorbl4lbstskjv8tk92og4","key":"PHPSESSID"}],"responseTime":"160","body":"{\"code\":201,\"data\":{\"id\":440,\"contacts_in_segment\":1},\"message\":\"Created\"}"},{"id":"1ab89a12-4b23-56f1-446f-280cf7a85a5f","name":"Error-Bad Request","originalRequest":{"method":"POST","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"name","value":"","type":"text"},{"key":"live_time","value":"2","type":"text"},{"key":"contact_origin","value":"3","type":"text"},{"key":"contacts[0]","value":"","type":"text"},{"key":"contacts[1]","value":"","type":"text","disabled":true}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/segmentation/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"51","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Thu, 05 Oct 2017 10:21:27 GMT","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"l00ihorbl4lbstskjv8tk92og4","key":"PHPSESSID"}],"responseTime":"73","body":"{\"code\":400,\"message\":\"Bad Request\",\"errorCode\":90}"}],"_postman_id":"88474f25-6bee-338b-42d2-32d98b9e4634"},{"name":"Removing contacts from segments created by API","id":"7221d551-9554-4a2d-aade-dd69d47e1df4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"ipresso-external-key","value":"ExternalID","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"contact_origin","value":"1","description":"Origin of contact's
\n","type":"text"},{"key":"contacts[0]","value":"ID_CONTACT_1","description":"E-mail or contact's ID's
\n","type":"text"},{"key":"contacts[1]","value":"ID_CONTACT_2","type":"text"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/segmentation/ID_SEGMENTATION/contact-remove","description":"In order to remove contact from segment via iPresso API POST request should be sent to the URL: https://CLIENT_PANEL_ADDRESS/api/2/segmentation/ID_SEGMENTATION/contact-remove.
\n\nParameter
\nID_SEGMENTATIONneeds to be replaced with an ID of segmentation from which you want to remove contacts.
Removing contacts from segment via API is possible only for segments created by API.
\n\n\nParameter
\ncontact_originmarks the origin of contacts. If you want to remove contacts tofrom segment by their IDs or external IDs, parametercontact_originshould be set to 1, if by contact hash values to 3 and if by their e-mail addresses, to 2.
\n\nParameter
\ncontact_typeis optional. Only contacts with given e-mail addresses and contact type will be removed from the segment if you define this parameter. ValueTYPE_KEYneeds to be replaced by the API key of specific contact type.
In order do remove contacts using their external ID, the ipresso-external-key parameter should be passed in the header.
\n\nParameter
\nipresso-external-keyis an optional parameter. It adopts the values of external ID groups defined in iPresso.
Array contacts needs to contain only e-mail addresses, ID or external ID depending on defined earlier contact_origin parameter.
Name of segmentation
\n"},{"key":"live_time","value":"3","description":"Segment availability in full hours
\n"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/segmentation","description":"In order to add new segmentation via iPresso API POST request should be sent to the URL: https://CLIENT_PANEL_ADDRESS/api/2/segmentation.
\n\nParameter
\nlive_timemarks the time in full hours in which the segment will be available to perform any actions on it. Parameterlive_timeaccepts only integer values.
Maximum value of live_time must not exceed 168.
It is possible to create an empty segment.
\n\n\nParameter
\ncontact_originmarks the origin of contacts. If you want to add contacts to segment by their IDs, parametercontact_originshould be set to 1, if by contact hash values to 3 and if by their e-mail addresses, to 2.
\n\nParametr
\ncontact_typeis optional. Only contacts with given e-mail addresses and contact type will be added to the segment if you define this parameter. ValueTYPE_KEYneeds to be replaced by the API key of specific contact type.
Array contacts needs to contain only ID numbers or e-mail addresses, depending on defined earlier contact_origin parameter.
It is possible to send only up to 1000 contacts in one request.
\n","urlObject":{"protocol":"https","path":["api","2","segmentation"],"host":["CLIENT_PANEL_ADDRESS"],"query":[],"variable":[]}},"response":[{"id":"e9f8bc17-c51d-4dbd-baa4-e8e2a4d84da8","name":"Success","originalRequest":{"method":"POST","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"name","value":"Name","description":"Nazwa segmentu"},{"key":"live_time","value":"1-168","description":"Czas dostepności segmentu"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/segmentation"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"content-encoding","value":"gzip","description":""},{"key":"content-length","value":"89","description":""},{"key":"content-type","value":"text/json;charset=UTF-8","description":""},{"key":"date","value":"Thu, 05 Oct 2017 10:34:05 GMT","description":""},{"key":"vary","value":"Accept-Encoding","description":""},{"key":"x-content-type-options","value":"nosniff","description":""}],"cookie":[],"responseTime":"225","body":"{\"code\":201,\"data\":{\"id\":443,\"contacts_in_segment\":0},\"message\":\"Created\"}"},{"id":"11b450e5-cfb6-c288-1351-b292efba0518","name":"Error-Bad request","originalRequest":{"method":"POST","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"name","value":"Name","description":"Nazwa segmentu"},{"key":"live_time","value":"1-168","description":"Czas dostępności segmentu"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/segmentation"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"51","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Thu, 05 Oct 2017 08:13:45 GMT","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"l00ihorbl4lbstskjv8tk92og4","key":"PHPSESSID"}],"responseTime":"168","body":"{\"code\":400,\"message\":\"Bad Request\",\"errorCode\":90}"}],"_postman_id":"7e8e472f-2487-2a3a-0bf0-36c70a6d68a8"},{"name":"Deleting a segment created by API","id":"e069063b-4c13-51e7-6cb5-e1db1e259ccf","request":{"method":"DELETE","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"formdata","formdata":[]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/segmentation/ID_SEGMENTATION.","description":"In order to delete a segmentation via iPresso API DELETE request should be sent to the URL: https://CLIENT_PANEL_ADDRESS/api/2/segmentation/ID_SEGMENTATION.
\n\nParameter
\nID_SEGMENTATIONneeds to be replaced with an ID of segmentation you want to delete.
**Only segments created by API can be deleted this way. **
\n","urlObject":{"protocol":"https","path":["api","2","segmentation","ID_SEGMENTATION."],"host":["CLIENT_PANEL_ADDRESS"],"query":[],"variable":[]}},"response":[{"id":"45df97c2-6874-6edd-619b-60c4cacc46a5","name":"Success","originalRequest":{"method":"DELETE","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"url":"https://CLIENT_PANEL_ADDRESS/api/2/segmentation/ID_SEGMENTATION."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"27","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Thu, 05 Oct 2017 10:24:43 GMT","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"l00ihorbl4lbstskjv8tk92og4","key":"PHPSESSID"}],"responseTime":"162","body":"{\"code\":200,\"message\":\"OK\"}"},{"id":"273a8551-d2ed-9087-8941-ed53e069ccb4","name":"Error-Not Found","originalRequest":{"method":"DELETE","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"url":"https://CLIENT_PANEL_ADDRESS/api/2/segmentation/ID_SEGMENTATION."},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"49","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Thu, 05 Oct 2017 10:25:17 GMT","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"l00ihorbl4lbstskjv8tk92og4","key":"PHPSESSID"}],"responseTime":"166","body":"{\"code\":404,\"message\":\"Not Found\",\"errorCode\":94}"}],"_postman_id":"e069063b-4c13-51e7-6cb5-e1db1e259ccf"},{"name":"Get contacts from segmentation","id":"e25521e1-2413-cc4a-1116-fd6b8ff8a6e1","request":{"method":"GET","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"formdata","formdata":[]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/segmentation/ID_SEGMENTATION","description":"In order to get contacts from segmentation send GET request to the URL: https://CLIENT_PANEL_ADDRESS/api/2/segmentation/ID_SEGMENTATION.
\n\n","urlObject":{"protocol":"https","path":["api","2","segmentation","ID_SEGMENTATION"],"host":["CLIENT_PANEL_ADDRESS"],"query":[],"variable":[]}},"response":[{"id":"1c1e9432-6dc7-0358-ec27-d09665ff1de4","name":"Success","originalRequest":{"method":"GET","header":[],"url":"https://CLIENT_PANEL_ADDRESS/api/2/segmentation/ID_SEGMENTATION"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"[\n {\n \"code\":200,\n \"data\":\n {\n \"contact\":\n {\n \"249726\":\n {\n \"hashIdContact\":\"y28jL22sSvhJl-V3Jk0M4PCLCcven23Y3LTdyMheXjQ.\"\n }\n }\n }\n\n },\n \"message\":\"OK\"\n]"},{"id":"f4a8fdd3-9e9f-8c06-e4d1-d561dbedb6fa","name":"Error 404","originalRequest":{"method":"GET","header":[],"url":"https://CLIENT_PANEL_ADDRESS/api/2/segmentation/ID_SEGMENTATION"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"[\n {\"code\":404,\n \"message\":\"Not found\"\n }\n]"}],"_postman_id":"e25521e1-2413-cc4a-1116-fd6b8ff8a6e1"},{"name":"Get active segmentations","id":"60a0cb18-0cd8-6b97-40ed-c656b25f0388","request":{"method":"GET","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"formdata","formdata":[]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/segmentation","description":"Parameter
\nID_SEGMENTATIONneeds to be replaced with an ID of segmentation.
In order to get active segmentations, make GET request on: https://CLIENT_PANEL_ADDRESS/api/2/segmentation
\n\nParameter
\nCLIENT_PANEL_ADDRESSneeds to be replaced with your iPresso URL.
Segmentation params:
\n","urlObject":{"protocol":"https","path":["api","2","segmentation"],"host":["CLIENT_PANEL_ADDRESS"],"query":[],"variable":[]}},"response":[{"id":"d9ec1c98-de3c-54a5-6106-b78b9fc393fa","name":"Success","originalRequest":{"method":"GET","header":[],"url":"https://CLIENT_PANEL_ADDRESS/api/2/segmentation/ID_SEGMENTATION"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{ \n \"code\":200,\n \"data\":{ \n \"segmentations\":{ \n \"1925\":{ \n \"id_segmentation\":1925,\n \"name\":\"test name 1\",\n \"origin\":\"1\",\n \"valid_to\":\"2018-03-20 16:27:54\",\n \"live_time\":\"8\",\n \"reload_interval\":6,\n \"reload_interval_type\":1,\n \"contacts_in_segment\":\"2742\",\n \"create_date\":\"2018-03-20 08:27:54\"\n },\n \"1936\":{ \n \"id_segmentation\":1936,\n \"name\":\"test name 2\",\n \"origin\":\"1\",\n \"valid_to\":\"2018-03-20 16:27:44\",\n \"live_time\":\"8\",\n \"reload_interval\":null,\n \"reload_interval_type\":null,\n \"contacts_in_segment\":\"27\",\n \"create_date\":\"2018-03-20 08:27:44\",\n \"actions\":[ \n 4,\n 2\n ]\n }\n }\n },\n \"message\":\"OK\"\n}"}],"_postman_id":"60a0cb18-0cd8-6b97-40ed-c656b25f0388"}],"id":"0aff00f9-b559-5827-fb3d-1d7000bb67dd","_postman_id":"0aff00f9-b559-5827-fb3d-1d7000bb67dd","description":""},{"name":"Source of contact","item":[{"name":"Get all contact sources","id":"9c29c8de-818c-29b2-2e6a-cfbf5602f887","request":{"method":"GET","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"formdata","formdata":[]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/origin","description":"In order to get all contact sources send GET to the URL:\nhttps://CLIENT_PANEL_ADDRESS/api/2/origin
Parameter CLIENT_PANEL_ADDRESS should be replaced with the URL address of iPresso.
In order to get contacts from a given source send GET request to the URL:\nhttps://CLIENT_PANEL_ADDRESS/api/2/origin/ID_ORIGIN/contact
\n\nParameter
\nCLIENT_PANEL_ADDRESSshould be replaced with the URL address of iPresso.
\n\nParameter
\nID_ORIGINshould be replaced with ID number of contact’s source.
In the case of getting large number of contacts assigned to a given source, the system will respond with just the first page of 50 records. In order to see other pages it is necessary to define which page is to be displayed by adding to the link parameter ?page=N where N corresponds to the number of the page, e.g.: https://CLIENT_PANEL_ADDRESS/api/2/origin/ID_ORIGIN/contact?page=2
In order to log into customer account via API send POST request to the url address https://CLIENT_PANEL_ADDRESS/api/2/authorization/panel.
\n\nParameters
\nUSER_LOGINandUSER_PASSWORDshould be replaced with the login and password assigned to user.
\n\nSession is valid for 2 hours.
\n
\n\nThe url in
\nauth_urlis used for logging into customer account.
\n\nIn order to log into customer account via API and go to the Contact Manager, send a GET or POST request to the url address received as a response in auth_url, e.g.
\nhttps://CLIENT_PANEL_ADDRESS/v2/login?oneTimeAuthToken=xyzwithoneTimeAuthTokenparameter eg. e3ba8aa6ceec0f1052c8f6d59a1999f2 and [optional] redirect_url parameter eg.https://CLIENT_PANEL_ADDRESS/v2/contact-manager.
\n\n","urlObject":{"protocol":"https","path":["api","2","authorization","panel"],"host":["CLIENT_PANEL_ADDRESS"],"query":[],"variable":[]}},"response":[{"id":"dd052550-fdba-af2f-6545-ed1dc1a0dac8","name":"Success","originalRequest":{"method":"POST","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"login","value":"USER_LOGIN","type":"text"},{"key":"password","value":"USER_PASSWORD","type":"text"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/authorization/panel"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"content-encoding","value":"gzip","description":""},{"key":"content-length","value":"151","description":""},{"key":"content-type","value":"text/json;charset=UTF-8","description":""},{"key":"date","value":"Fri, 06 Oct 2017 06:25:19 GMT","description":""},{"key":"vary","value":"Accept-Encoding","description":""},{"key":"x-content-type-options","value":"nosniff","description":""}],"cookie":[],"responseTime":"234","body":"{\n \"code\": 200,\n \"data\": {\n \"auth_url\": \"https://CLIENT_PANEL_ADDRESS/v2/login?oneTimeAuthToken=xyz\"\n },\n \"message\": \"OK\"\n}"},{"id":"3a180263-7fe5-2a15-b307-8bdb6ef35cfc","name":"Error - Not Found","originalRequest":{"method":"POST","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"login","value":"USER_LOGIN","type":"text"},{"key":"password","value":"USER_PASSWORD","type":"text"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/authorization/panel"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"content-length","value":"34","description":""},{"key":"content-type","value":"text/json;charset=UTF-8","description":""},{"key":"date","value":"Fri, 06 Oct 2017 06:29:28 GMT","description":""},{"key":"x-content-type-options","value":"nosniff","description":""}],"cookie":[],"responseTime":"94","body":"{\"code\":404,\"message\":\"Not Found\"}"}],"_postman_id":"8713c229-f70c-7760-8896-3d4707bf5ccf"}],"id":"88330df2-b4f0-d539-0cf5-81aab6358e70","_postman_id":"88330df2-b4f0-d539-0cf5-81aab6358e70","description":""},{"name":"Monitored site","item":[{"name":"Get monitored sites","id":"c1a5a7a0-3075-142f-9246-1bc96705f7fa","request":{"method":"GET","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"url":"https://CLIENT_PANEL_ADDRESS/api/2/www","description":"sample URL:
\nhttps://CLIENT_PANEL_ADDRESS/authorization/log-in/?oneTimeAuthToken=e3ba8aa6ceec0f1052c8f6d59a1999f2&redirect_url=https://CLIENT_PANEL_ADDRESS/contact-manager
In order to get all monitored sites send GET request to the URL: https://CLIENT_PANEL_ADDRESS/api/2/www
In order to get data of monitored sites send GET request to the URL:https://CLIENT_PANEL_ADDRESS/api/2/www/ID_WWW
\n\n","urlObject":{"protocol":"https","path":["api","2","www","ID_WWW"],"host":["CLIENT_PANEL_ADDRESS"],"query":[],"variable":[]}},"response":[{"id":"144a465b-db46-f557-3b9b-38cd15d78c36","name":"success","originalRequest":{"method":"GET","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"url":"https://CLIENT_PANEL_ADDRESS/api/2/www/ID_WWW"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Encoding","value":"gzip","description":""},{"key":"Content-Length","value":"788","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Thu, 05 Oct 2017 07:58:53 GMT","description":""},{"key":"Vary","value":"Accept-Encoding","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"5ru4jlnfi6pmao3os1q84vnc45","key":"PHPSESSID"}],"responseTime":"259","body":"{\n \"code\": 200,\n \"data\": {\n \"www\": {\n \"id\": \"7\",\n \"url\": \"http://ipresso.pl\",\n \"create_date\": \"2012-06-26\",\n \"last_check\": \"2016-07-05 11:23:24\",\n \"code\": \"\",\n \"codeLegacy\": \"\"\n }\n },\n \"message\": \"OK\"\n}"}],"_postman_id":"a314e679-1149-3c12-4d20-4811abfc0890"},{"name":"Add monitored site","id":"5d2423c5-b0da-1228-f63d-e83e2de53de6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"www[url]","type":"text","value":"SITE_URL"},{"key":"www[js_api_methods][JS_API_KEY]","value":"1","type":"text"},{"key":"www[js_api_methods][JS_API_KEY]","value":"0","type":"text"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/www","description":"Parameter
\nID_WWWshould be replaced with ID of monitored site.
In order to add a new site send POST request to the URL: https://CLIENT_PANEL_ADDRESS/api/2/www
\n\nParameter
\nSITE_URLshould be replaced with a correct URL (containing https://).
In order to use JS API fully, it is possible (optionally) to turn on selected JS API methods, which should be active on the monitored site. Also, it is possible to turn off methods which are active by default. To switch the method on and off you should replace JS_API_KEY parameter with proper JS API method key. In order to turn on method, send JS API key with 1 value. To turn off method, send JS API key with 0 value.
All methods and keys are available in client's panel after log in. Navigate to Site monitoring module, click more next to any monitored website on the listing and then choose JS API method settings.
\nIn response, tracking code will be returned - where 'SCRIPT' placeholder is located in the example.
\n","urlObject":{"protocol":"https","path":["api","2","www"],"host":["CLIENT_PANEL_ADDRESS"],"query":[],"variable":[]}},"response":[{"id":"918e1247-f9de-0dc8-852a-f01767b953cc","name":"success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"www[url]","value":"SITE_URL","type":"text"},{"key":"www[js_api_methods][JS_API_KEY]","value":"1","type":"text"},{"key":"www[js_api_methods][JS_API_KEY]","value":"0","type":"text"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/www"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Encoding","value":"gzip","description":""},{"key":"Content-Length","value":"773","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Thu, 05 Oct 2017 07:51:03 GMT","description":""},{"key":"Vary","value":"Accept-Encoding","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"5ru4jlnfi6pmao3os1q84vnc45","key":"PHPSESSID"}],"responseTime":"198","body":"{\n \"code\": 201,\n \"data\": {\n \"www\": {\n \"id\": 29,\n \"url\": \"http://ipresso.pl\",\n \"create_date\": \"2017-10-05\",\n \"last_check\": false,\n \"code\": \"\",\n \"codeLegacy\": \"\"\n }\n },\n \"message\": \"Created\"\n}"},{"id":"1aea9bf9-3919-65cd-a2ef-c6b199475b12","name":"error-Found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"www[url]","value":"SITE_URL","type":"text"},{"key":"www[js_api_methods][JS_API_KEY]","value":"1","type":"text"},{"key":"www[js_api_methods][JS_API_KEY]","value":"0","type":"text"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/www"},"status":"Found","code":302,"_postman_previewlanguage":"json","header":[{"key":"Content-Encoding","value":"gzip","description":""},{"key":"Content-Length","value":"790","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Thu, 05 Oct 2017 07:55:06 GMT","description":""},{"key":"Vary","value":"Accept-Encoding","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"5ru4jlnfi6pmao3os1q84vnc45","key":"PHPSESSID"}],"responseTime":"591","body":"{\n \"code\": 302,\n \"data\": {\n \"www\": {\n \"id\": \"10\",\n \"url\": \"http://ipresso9.pl\",\n \"create_date\": \"2013-06-26\",\n \"last_check\": \"2014-09-15 13:43:02\",\n \"code\": \"SCRIPT\"\n }\n },\n \"message\": \"Found\"\n}"},{"id":"3dcf0001-958a-07df-9074-c3a125cf17c7","name":"error-Not Found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"www[url]","value":"SITE_URL","type":"text"},{"key":"www[js_api_methods][JS_API_KEY]","value":"1","type":"text"},{"key":"www[js_api_methods][JS_API_KEY]","value":"0","type":"text"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/www"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"49","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Thu, 05 Oct 2017 07:51:33 GMT","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"5ru4jlnfi6pmao3os1q84vnc45","key":"PHPSESSID"}],"responseTime":"199","body":"{\"code\":404,\"message\":\"Not Found\",\"errorCode\":66}"},{"id":"bc23cb35-c7ef-410a-af3d-3b8ac5a8c2d2","name":"Bad request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"www[url]","type":"text","value":"SITE_URL"},{"key":"www[js_api_methods][JS_API_KEY]","value":"1","type":"text"},{"key":"www[js_api_methods][JS_API_KEY]","value":"0","type":"text"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/www"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"code\": 400,\n \"message\": \"Bad Request\",\n \"errorCode\": 114\n}"}],"_postman_id":"5d2423c5-b0da-1228-f63d-e83e2de53de6"},{"name":"Delete monitored site","id":"f7eaae3c-6081-a799-1fc9-49b54afc5c2a","request":{"method":"DELETE","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"url":"https://CLIENT_PANEL_ADDRESS/api/2/www/ID_WWW","description":"In order to delete site send DELETE request to the URL: https://CLIENT_PANEL_ADDRESS/api/2/www/ID_WWW
\n\n","urlObject":{"protocol":"https","path":["api","2","www","ID_WWW"],"host":["CLIENT_PANEL_ADDRESS"],"query":[],"variable":[]}},"response":[{"id":"d8bc251e-3148-134d-6500-1899615458b2","name":"success","originalRequest":{"method":"GET","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"url":"https://CLIENT_PANEL_ADDRESS/api/2/www/ID_WWW"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Encoding","value":"gzip","description":""},{"key":"Content-Length","value":"768","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Thu, 05 Oct 2017 08:01:20 GMT","description":""},{"key":"Vary","value":"Accept-Encoding","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"5ru4jlnfi6pmao3os1q84vnc45","key":"PHPSESSID"}],"responseTime":"116","body":"{\n \"code\": 200,\n \"data\": {\n \"www\": {\n \"id\": \"30\",\n \"url\": \"http://ipresso.pl\",\n \"create_date\": \"2017-10-05\",\n \"last_check\": null,\n \"code\": \"\"\n }\n },\n \"message\": \"OK\"\n}"},{"id":"9159407f-731d-f3bf-a398-96db25069aa7","name":"error-Not Found","originalRequest":{"method":"GET","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"url":"https://CLIENT_PANEL_ADDRESS/api/2/www/ID_WWW"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"34","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Thu, 05 Oct 2017 08:02:51 GMT","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"5ru4jlnfi6pmao3os1q84vnc45","key":"PHPSESSID"}],"responseTime":"133","body":"{\"code\":404,\"message\":\"Not Found\"}"}],"_postman_id":"f7eaae3c-6081-a799-1fc9-49b54afc5c2a"}],"id":"2b7c89a8-e238-8166-e5f1-00d1b241cc0d","_postman_id":"2b7c89a8-e238-8166-e5f1-00d1b241cc0d","description":""},{"name":"iPresso Availability Monitoring","item":[{"name":"iPresso Availability Monitoring","id":"0e2b59b8-712e-4286-ac66-d19af7a703a1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"User-Agent","value":"iPresso","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-Authorization","value":"[Token required to check system status]","type":"text"}],"url":"https://CLIENT_PANEL_ADDRESS/api/2/status","description":"Parameter
\nID_WWWshould be replaced with ID of monitored site.
To check iPresso's availability via the API, you need to make a GET request to the following URL:
\nhttps://CLIENT_PANEL_ADDRESS/api/2/status
For authorization, you'll need to provide the token (the one required for checking system status) as the value for the X-Authorization key in the headers. You can generate this token in your iPresso client panel, from the list of API users.
\n","urlObject":{"protocol":"https","path":["api","2","status"],"host":["CLIENT_PANEL_ADDRESS"],"query":[],"variable":[]}},"response":[{"id":"6b3ea80a-84fb-4eed-a9e8-ebde9f7ddc1e","name":"Success","originalRequest":{"method":"GET","header":[{"key":"User-Agent","value":"iPresso","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-Authorization","value":"[Token required to check system status]","type":"text"}],"url":"https://CLIENT_PANEL_ADDRESS/api/2/status"},"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"code\": 200,\n \"message\": \"OK\"\n}"},{"id":"dc35fe87-5915-473d-b018-f5357f76d926","name":"Error - Authorization error","originalRequest":{"method":"GET","header":[{"key":"User-Agent","value":"iPresso","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-Authorization","value":"[Token required to check system status]","type":"text"}],"url":"https://CLIENT_PANEL_ADDRESS/api/2/status"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"code\": 403,\n \"message\": \"Unauthorized\"\n}"},{"id":"d3895619-0644-4176-b9db-9b64d2632c2c","name":"Error - Service error","originalRequest":{"method":"GET","header":[{"key":"User-Agent","value":"iPresso","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-Authorization","value":"[Token required to check system status]","type":"text"}],"url":"https://CLIENT_PANEL_ADDRESS/api/2/status"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"code\": 503,\n \"message\": \"One or more services are currently experiencing issues. Please try again later or contact support.\"\n}"}],"_postman_id":"0e2b59b8-712e-4286-ac66-d19af7a703a1"}],"id":"511c809e-2498-4c64-8f82-64d171e2c0e9","_postman_id":"511c809e-2498-4c64-8f82-64d171e2c0e9","description":""},{"name":"Customer attributes","item":[{"name":"Get available customer attributes","event":[{"listen":"test","script":{"id":"28e46300-5361-42be-a93b-c9a6f43fc5cf","exec":[""],"type":"text/javascript","packages":{}}}],"id":"adda7e9f-8b71-44cf-a889-a2dc5c9f77e8","request":{"method":"GET","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"raw","raw":""},"url":"https://CLIENT_PANEL_ADDRESS/api/2/attribute/customer","description":"In order to get customer attributes send GET request to the URL: https://CLIENT_PANEL_ADDRESS/api/2/attribute/customer
In order to edit customer attribute send POST request on the URL: https://CLIENT_PANEL_ADDRESS/api/2/attribute/customer/ATTRIBUTE_KEY
\n\nParameter
\nNEW_ATTRIBUTE_NAMEshould be replace with new attribute name.
\n\nParameter
\nNEW_ATTRIBUTE_KEYshould be replaced with new attribute key.
\n\nParameter
\nNEW_ATTRIBUTE_VALUEshould be replaced with new attribute value.
\n\n","urlObject":{"protocol":"https","path":["api","2","attribute","customer"],"host":["CLIENT_PANEL_ADDRESS"],"query":[],"variable":[]}},"response":[{"id":"c0e102f6-7ddc-4b20-a682-2545e648f0e1","name":"Success","originalRequest":{"method":"PUT","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"formdata","formdata":[]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/attribute/customer"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Content-Encoding","value":"gzip","description":"The type of encoding used on the data."},{"key":"Content-Length","value":"137","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":"The mime type of this content"},{"key":"Date","value":"Mon, 06 Aug 2018 08:25:57 GMT","description":"The date and time that the message was sent"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT","description":"Gives the date/time after which the response is considered stale"},{"key":"Pragma","value":"no-cache","description":"Implementation-specific headers that may have various effects anywhere along the request-response chain."},{"key":"Vary","value":"Accept-Encoding","description":"Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server."},{"key":"X-Content-Type-Options","value":"nosniff","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Content-Type-Options","value":"nosniff","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Powered-By","value":"PHP/7.0.28","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":false,"domain":"panel.qa13-ipresso.encja.eu","path":"/","secure":false,"value":"d4bcffeb422067b1c6e596714d999bfd","key":"PHPSESSID"}],"responseTime":null,"body":"{\n \"code\": 201,\n \"message\": \"Created\"\n}"},{"id":"267e26c4-178a-4dc5-82a5-f037f5bfbd56","name":"Error - Forbidden","originalRequest":{"method":"PUT","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"formdata","formdata":[]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/attribute/customer"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Content-Length","value":"49","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":"The mime type of this content"},{"key":"Date","value":"Mon, 06 Aug 2018 08:32:10 GMT","description":"The date and time that the message was sent"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT","description":"Gives the date/time after which the response is considered stale"},{"key":"Pragma","value":"no-cache","description":"Implementation-specific headers that may have various effects anywhere along the request-response chain."},{"key":"X-Content-Type-Options","value":"nosniff","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Content-Type-Options","value":"nosniff","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Powered-By","value":"PHP/7.0.28","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":false,"domain":"panel.qa13-ipresso.encja.eu","path":"/","secure":false,"value":"d4bcffeb422067b1c6e596714d999bfd","key":"PHPSESSID"}],"responseTime":null,"body":"{\n \"code\": 403,\n \"message\": \"Forbidden\",\n \"errorCode\": 65\n}"}],"_postman_id":"8e79aabc-1b12-4576-b1eb-c668812f6cfd"},{"name":"Add new customer attributes","id":"02c39683-3419-422e-a26c-046b2cc8da72","request":{"method":"POST","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"name","value":"ATTRIBUTE_NAME","type":"text"},{"key":"key","value":"ATTRIBUTE_KEY","type":"text"},{"key":"value","value":"ATTRIBUTE_VALUE","type":"text"},{"key":"type","value":"ATTRIBUTE_TYPE","type":"text"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/attribute/customer","description":"Parameter
\nNEW_ATTRIBUTE_TYPEshould be replaced with new attribute type.
In order to add new customer attribute send POST request on the URL: https://CLIENT_PANEL_ADDRESS/api/2/attribute/customer
\n\nParameter
\nATTRIBUTE_NAMEshould be replace with an attribute name.
\n\nParameter
\nATTRIBUTE_KEYshould be replaced with attribute key.
\n\nParameter
\nATTRIBUTE_VALUEshould be replaced with attribute value.
\n\nParameter
\nATTRIBUTE_TYPEshould be replaced with attribute type.
Kinds of available attribute types:
\n","urlObject":{"protocol":"https","path":["api","2","attribute","customer"],"host":["CLIENT_PANEL_ADDRESS"],"query":[],"variable":[]}},"response":[{"id":"3e195a77-fbec-4864-b070-7f7ee232244a","name":"Success","originalRequest":{"method":"POST","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"name","value":"ATTRIBUTE_NAME","type":"text"},{"key":"key","value":"ATTRIBUTE_KEY","type":"text"},{"key":"value","value":"ATTRIBUTE_VALUE","type":"text"},{"key":"type","value":"ATTRIBUTE_TYPE","type":"text"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/attribute/customer"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Content-Encoding","value":"gzip","description":"The type of encoding used on the data."},{"key":"Content-Length","value":"137","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":"The mime type of this content"},{"key":"Date","value":"Mon, 06 Aug 2018 08:25:57 GMT","description":"The date and time that the message was sent"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT","description":"Gives the date/time after which the response is considered stale"},{"key":"Pragma","value":"no-cache","description":"Implementation-specific headers that may have various effects anywhere along the request-response chain."},{"key":"Vary","value":"Accept-Encoding","description":"Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server."},{"key":"X-Content-Type-Options","value":"nosniff","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Content-Type-Options","value":"nosniff","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Powered-By","value":"PHP/7.0.28","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":false,"domain":"panel.qa13-ipresso.encja.eu","path":"/","secure":false,"value":"d4bcffeb422067b1c6e596714d999bfd","key":"PHPSESSID"}],"responseTime":null,"body":"{\n \"code\": 201,\n \"data\": {\n \"attribute\": {\n \"4\": {\n \"name\": \"ATTRIBUTE_NAME\",\n \"value\": \"ATTRIBUTE_VALUE\",\n \"type\": 4,\n \"api_key\": \"ATTRIBUTE_KEY\",\n \"id\": 4\n }\n }\n },\n \"message\": \"Created\"\n}"},{"id":"299d872e-ca7b-4322-8c56-6a65db03e196","name":"Error - Not Found","originalRequest":{"method":"POST","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"name","value":"ATTRIBUTE_NAME","type":"text"},{"key":"key","value":"ATTRIBUTE_KEY","type":"text"},{"key":"value","value":"ATTRIBUTE_VALUE","type":"text"},{"key":"type","value":"ATTRIBUTE_TYPE","type":"text"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/attribute/customer"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Content-Length","value":"49","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":"The mime type of this content"},{"key":"Date","value":"Mon, 06 Aug 2018 08:32:10 GMT","description":"The date and time that the message was sent"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT","description":"Gives the date/time after which the response is considered stale"},{"key":"Pragma","value":"no-cache","description":"Implementation-specific headers that may have various effects anywhere along the request-response chain."},{"key":"X-Content-Type-Options","value":"nosniff","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Content-Type-Options","value":"nosniff","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Powered-By","value":"PHP/7.0.28","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":false,"domain":"panel.qa13-ipresso.encja.eu","path":"/","secure":false,"value":"d4bcffeb422067b1c6e596714d999bfd","key":"PHPSESSID"}],"responseTime":null,"body":"{\n \"code\": 404,\n \"message\": \"Not Found\",\n \"errorCode\": 24\n}"},{"id":"bf83dc93-5613-4261-9436-e1cfc198ef85","name":"Error - Found","originalRequest":{"method":"POST","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"name","value":"ATTRIBUTE_NAME","type":"text"},{"key":"key","value":"ATTRIBUTE_KEY","type":"text"},{"key":"value","value":"ATTRIBUTE_VALUE","type":"text"},{"key":"type","value":"ATTRIBUTE_TYPE","type":"text"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/attribute/customer"},"status":"Found","code":302,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Content-Encoding","value":"gzip","description":"The type of encoding used on the data."},{"key":"Content-Length","value":"135","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":"The mime type of this content"},{"key":"Date","value":"Mon, 06 Aug 2018 08:27:59 GMT","description":"The date and time that the message was sent"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT","description":"Gives the date/time after which the response is considered stale"},{"key":"Pragma","value":"no-cache","description":"Implementation-specific headers that may have various effects anywhere along the request-response chain."},{"key":"Vary","value":"Accept-Encoding","description":"Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server."},{"key":"X-Content-Type-Options","value":"nosniff","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Content-Type-Options","value":"nosniff","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Powered-By","value":"PHP/7.0.28","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":false,"domain":"panel.qa13-ipresso.encja.eu","path":"/","secure":false,"value":"d4bcffeb422067b1c6e596714d999bfd","key":"PHPSESSID"}],"responseTime":null,"body":"{\n \"code\": 302,\n \"data\": {\n \"attribute\": {\n \"4\": {\n \"id\": \"4\",\n \"name\": \"ATTRIBUTE_NAME\",\n \"value\": \"ATTRIBUTE_VALUE\",\n \"key\": \"ATTRIBUTE_KEY\",\n \"type\": \"text\"\n }\n }\n },\n \"message\": \"Found\"\n}"}],"_postman_id":"02c39683-3419-422e-a26c-046b2cc8da72"},{"name":"Delete customer attribute","id":"de318424-67b6-453d-842a-edfd4d82db66","request":{"method":"DELETE","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"formdata","formdata":[]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/attribute/customer/ATTRIBUTE_KEY","description":"In order to delete customer attribute send DELETE request on the URL: https://CLIENT_PANEL_ADDRESS/api/2/attribute/customer/ATTRIBUTE_KEY
\n\n","urlObject":{"protocol":"https","path":["api","2","attribute","customer","ATTRIBUTE_KEY"],"host":["CLIENT_PANEL_ADDRESS"],"query":[],"variable":[]}},"response":[{"id":"9688c903-2f4b-4910-932f-389d72aa79c8","name":"Success","originalRequest":{"method":"DELETE","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"formdata","formdata":[]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/attribute/customer/ATTRIBUTE_KEY"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Content-Encoding","value":"gzip","description":"The type of encoding used on the data."},{"key":"Content-Length","value":"137","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":"The mime type of this content"},{"key":"Date","value":"Mon, 06 Aug 2018 08:25:57 GMT","description":"The date and time that the message was sent"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT","description":"Gives the date/time after which the response is considered stale"},{"key":"Pragma","value":"no-cache","description":"Implementation-specific headers that may have various effects anywhere along the request-response chain."},{"key":"Vary","value":"Accept-Encoding","description":"Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server."},{"key":"X-Content-Type-Options","value":"nosniff","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Content-Type-Options","value":"nosniff","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Powered-By","value":"PHP/7.0.28","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":false,"domain":"panel.qa13-ipresso.encja.eu","path":"/","secure":false,"value":"d4bcffeb422067b1c6e596714d999bfd","key":"PHPSESSID"}],"responseTime":null,"body":"{\n \"code\": 200,\n \"message\": \"OK\"\n}"},{"id":"d0f17114-7589-4275-8539-ca100bcabfa8","name":"Error - Forbidden","originalRequest":{"method":"DELETE","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"formdata","formdata":[]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/attribute/customer/ATTRIBUTE_KEY"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Content-Length","value":"49","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":"The mime type of this content"},{"key":"Date","value":"Mon, 06 Aug 2018 09:33:10 GMT","description":"The date and time that the message was sent"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT","description":"Gives the date/time after which the response is considered stale"},{"key":"Pragma","value":"no-cache","description":"Implementation-specific headers that may have various effects anywhere along the request-response chain."},{"key":"X-Content-Type-Options","value":"nosniff","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Content-Type-Options","value":"nosniff","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Powered-By","value":"PHP/7.0.28","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":false,"domain":"panel.qa13-ipresso.encja.eu","path":"/","secure":false,"value":"d4bcffeb422067b1c6e596714d999bfd","key":"PHPSESSID"}],"responseTime":null,"body":"{\"code\":403,\"message\":\"Forbidden\",\"errorCode\":65}"}],"_postman_id":"de318424-67b6-453d-842a-edfd4d82db66"}],"id":"2030e374-a12b-4e70-8f9b-f5779cb8ae7d","event":[{"listen":"prerequest","script":{"id":"274b706c-b1dc-4231-9a76-e261b9882089","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"aa9fbe30-5393-49d9-bb93-d4a5ae242276","type":"text/javascript","exec":[""]}}],"_postman_id":"2030e374-a12b-4e70-8f9b-f5779cb8ae7d","description":""},{"name":"Campaigns","item":[{"name":"Sending e-mails","id":"c390fc4c-5943-0e28-0ec3-aa36c2ba35e3","request":{"method":"POST","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"email[0]","value":"EMAIL","description":"Parameter
\nATTRIBUTE_KEYshould be replaced with customer attribute API key.
E-mail address
\n","type":"text"},{"key":"contactId[0]","value":"ID_CONTACT","description":"Contact ID number
\n","type":"text"},{"key":"content[HEAD]","value":"HEAD_CONTENT","description":"Header content
\n","type":"text"},{"key":"content[TEXT]","value":"TEXT_CONTENT","description":"Message content
\n","type":"text"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/campaign/ID/send","description":"In order to send message via iPresso API, POST request should be sent to the URL:
\n\nParameter
\nCLIENT_PANEL_ADDRESSshould be replaced with the URL address of one’s iPresso.
\n\nParameter
\nIDshould be replaced with the campaign ID.
\n\nParameter
\nAPI_KEYshould be replaced with the campaign API key.
You can send messages only to existing iPresso contacts, using the contact’s email email[] and contact’s ID contactId[].
You can use brackets in campaign content. For example, to replace brackets {_bracket1_} and {_bracket2_}, you need to use [‘content’][‘bracket1’] = ‘Hi’ and [‘content’][‘bracket2’] = ‘this is bracket content’.
In order to return message ID, append returnId=true parameter to the URL address. Examples:
External email address assigned to the contact id
\n"},{"key":"content[HEAD]","value":"HEAD_CONTENT","description":"Message header
\n","type":"text"},{"key":"content[TEXT]","value":"TEXT_CONTENT","description":"Message content
\n","type":"text"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/campaign/ID/send","description":"In order to send message via iPresso API \nto the e-mail address outside the system, POST request should be sent to the URL:
\n\nParameter CLIENT_PANEL_ADDRESS should be replaced with the URL address of one’s iPresso.
\n
\n\nParameter ID should be replaced with the campaign ID.
\n
\n\nParameter API_KEY should be replaced with the campaign API key.
\n
The camapign may be forwarded to an outside e-mail address if the contact with id assigned in the parameter ID_CONTACT exists in the system.
You can use brackets in campaign content. For example, to replace brackets {_HEAD_} and {_TEXT_}, you need to use [‘content’][‘HEAD’] = ‘Hi’ and `[‘content’][‘TEXT’] = ‘this is bracket content’.
In order to return message ID, append returnId=true parameter to the URL address. Examples:
Phone number
\n","type":"text"},{"key":"contactId[0]","value":"ID_CONTACT","description":"Contact ID number
\n","type":"text"},{"key":"content[text]","value":"TEXT","description":"Message content
\n","type":"text"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/campaign/ID/send","description":"In order to send message via iPresso API, POST request should be sent to the URL:
\n\nParameter
\nCLIENT_PANEL_ADDRESSshould be replaced with the URL address of one’s iPresso.
\n\nParameter
\nIDshould be replaced with the campaign ID.
\n\nParameter
\nAPI_KEYshould be replaced with the campaign API key.
You can send messages only to existing iPresso contacts, using contact’s mobilephones numbers array ($data[‘phone’][]) and contact’s IDs array ( $data[‘contactId’][]).
You can use brackets in campaign content. For example, to replace bracket {_bracket1_} you need to use $data[‘content’][‘bracket1’] = ‘this is bracket content’.
In order to return message ID, append returnId=true parameter to the URL address. Examples:
External telephone number assigned to the contact id
\n","type":"text"},{"key":"content[TEXT]","value":"TEXT","description":"SMS content
\n","type":"text"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/campaign/ID/send","description":"In order to send message via iPresso API in to external phone number, POST request should be sent to the URL:
\n\nParameter
\nCLIENT_PANEL_ADDRESSshould be replaced with the URL address of one’s iPresso.
\n\nParameter
\nIDshould be replaced with the campaign ID.
\n\nParameter
\nAPI_KEYshould be replaced with the campaign API key.
You can send sms messages to external phone number if parameter ID_CONTACT exists in iPresso.
You can use brackets in campaign content. For example, to replace bracket {_TEXT_} you need to use $data[‘content’][‘TEXT’] = ‘this is bracket content’.
In order to return message ID, append returnId=true parameter to the URL address. Examples:
In order to send message via iPresso API, POST request should be sent to the URL:
\n\nParameter
\nCLIENT_PANEL_ADDRESSshould be replaced with the URL address of one’s iPresso.
\n\nParameter
\nIDshould be replaced with the campaign ID.
\n\nParameter
\nAPI_KEYshould be replaced with the campaign API key.
You can send messages only to existing iPresso contacts, using contact’s push tokens array ($data[‘token’][]), contact’s IDs array ( $data[‘contactId’][]) and anonymous contacts hashes ( $data[‘hash’][]) .
You can use brackets in campaign content. For example, to replace bracket {_bracket1_} you need to use $data[‘content’][‘bracket1’] = ‘this is bracket content’.
In order to return message ID, append returnId=true parameter to the URL address. Examples:
In order to send message via iPresso API, POST request should be sent to the URL:
\n\nParameter
\nCLIENT_PANEL_ADDRESSshould be replaced with the URL address of one’s iPresso.
\n\nParameter
\nIDshould be replaced with the campaign ID.
\n\nParameter
\nAPI_KEYshould be replaced with the campaign API key.
You can send messages only to existing iPresso contacts, using contact’s push tokens array ($data[‘token’][]), contact’s IDs array ( $data[‘contactId’][]) and anonymous contacts hashes ( $data[‘hash’][]) .
You can use brackets in campaign content. For example, to replace bracket {_bracket1_} you need to use $data[‘content’][‘bracket1’] = ‘this is bracket content’.
In order to return message ID, append returnId=true parameter to the URL address. Examples:
Template key
\n","type":"text"},{"key":"name","value":"name","description":"Instant push name
\n","type":"text"},{"key":"description","value":"description","description":"Instant push description
\n","type":"text"},{"key":"type","value":"webPush","description":"Instant push type
\n","type":"text"},{"key":"wwwId","value":"1","description":"Monitored site ID: the page on which the message will be sent
\n","type":"text"},{"key":"topic","value":"topic_key","description":"Topic key. Topic includes recipients of the message. In order to send a web push to every valid token, send all value.
\n","type":"text"},{"key":"key","value":"instant_push_key","description":"Instant push key
\n","type":"text"},{"key":"expirationDate","value":"YYYY-MM-DD HH:MM:SS","description":"Expiration date after which the message will not be delivered to the recipient who was offline.
\n","type":"text"},{"key":"title","value":"title","description":"Instant push title
\n","type":"text"},{"key":"content","value":"content","description":"Instant push content
\n","type":"text"},{"key":"webPush[link]","value":"web push link","description":"The address to which the user will be redirected after clicking the notification.
\n","type":"text"},{"key":"webPush[iconUrl]","value":"icon URL","description":"Icon URL address
\n","type":"text"},{"key":"webPush[imageUrl]","value":"image URL","description":"Image URL address
\n","type":"text"},{"key":"webPush[buttons][0][label]","value":"button name","description":"Button name
\n","type":"text"},{"key":"webPush[buttons][0][link]","value":"button link","description":"The address to which the user will be redirected after clicking the button.
\n","type":"text"},{"key":"webPush[buttons][0][iconUrl]","value":"button icon URL","description":"Button icon URL address
\n","type":"text"},{"key":"webPush[buttons][0][label]","value":"button name","description":"Button name
\n","type":"text"},{"key":"webPush[buttons][0][link]","value":"button link","description":"The address to which the user will be redirected after clicking the button.
\n","type":"text"},{"key":"webPush[buttons][0][iconUrl]","value":"button icon URL","description":"Button icon URL address
\n","type":"text"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/campaign/instantpush","description":"In order to send instant push (type: web push) via iPresso API, POST request should be sent to the URL:
\n\nCLIENT_PANEL_ADDRESS parameter should be replaced with the iPresso URL address.
If template is not used (template parameter is not sent), required parameters are: name, type, wwwId, topic, title and content.
\nTemplates can be used by sending template parameter. Filling out additional fields in the body will overwrite template fields.
\nIf button name is added, button link is required. Users will be redirected to this link after clicking the button.
\nIf all required parameters won’t be sent in the request, code 400 will be returned with a proper message indicating what is missing.
\nThe time type parameter expirationDate[type], during which the message will be delivered to the recipient who is offline, can take 2 values:
date - specifies the expiry date of the message
\nperiodTime - specifies the period of validity of the message
\nWhen selecting the periodTime time interval, you should additionally pass the unit parameter specifying the hours / days units and amount with number of hours / days.
\nBe sure to select only one of the options.
\n","urlObject":{"protocol":"https","path":["api","2","campaign","instantpush"],"host":["CLIENT_PANEL_ADDRESS"],"query":[],"variable":[]}},"response":[{"id":"69f5591e-e895-4f91-bbe6-a68c51252d74","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Ipresso-Token","value":"55ac5b58e5a85babc6e7366eee0d3d6db14d18","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"template","value":"template_key","description":"Template key","type":"text"},{"key":"name","value":"name","description":"Instant push name","type":"text"},{"key":"description","value":"description","description":"Instant push description","type":"text"},{"key":"type","value":"webPush","description":"Instant push type","type":"text"},{"key":"wwwId","value":"1","description":"Monitored site ID: the page on which the message will be sent","type":"text"},{"key":"topic","value":"topic_key","description":"Topic key. Topic includes recipients of the message. In order to send a web push to every valid token, send **all** value.","type":"text"},{"key":"key","value":"instant_push_key","description":"Instant push key","type":"text"},{"key":"expirationDate[type]","value":"date","description":"Message validity type","type":"text"},{"key":"expirationDate[date]","value":"2021-11-11 00:00:00","description":"Expiration date after which the message will not be delivered to the recipient who was offline.","type":"text"},{"key":"title","value":"title","description":"Instant push title","type":"text"},{"key":"content","value":"content","description":"Instant push content","type":"text"},{"key":"webPush[link]","value":"https://www.ipresso.pl","description":"The address to which the user will be redirected after clicking the notification.","type":"text"},{"key":"webPush[iconUrl]","value":"https://global-uploads.webflow.com/5fb3a8f3ab924c7fbd6705da/5ffb553235288085e0bc9d8d_iPresso-BrandHero.png","description":"Icon URL address","type":"text"},{"key":"webPush[imageUrl]","value":"https://global-uploads.webflow.com/5fb3a8f3ab924c7fbd6705da/5ffb553235288085e0bc9d8d_iPresso-BrandHero.png","description":"Image URL address","type":"text"},{"key":"webPush[buttons][0][label]","value":"Button 1","description":"Button name","type":"text"},{"key":"webPush[buttons][0][link]","value":"https://www.ipresso.pl","description":"The address to which the user will be redirected after clicking the button.","type":"text"},{"key":"webPush[buttons][0][iconUrl]","value":"https://global-uploads.webflow.com/5fb3a8f3ab924c7fbd6705da/5ffb553235288085e0bc9d8d_iPresso-BrandHero.png","description":"Button icon URL address","type":"text"},{"key":"webPush[buttons][0][label]","value":"Button 2","description":"Button name","type":"text"},{"key":"webPush[buttons][0][link]","value":"https://www.ipresso.pl","description":"The address to which the user will be redirected after clicking the button.","type":"text"},{"key":"webPush[buttons][0][iconUrl]","value":"https://global-uploads.webflow.com/5fb3a8f3ab924c7fbd6705da/5ffb553235288085e0bc9d8d_iPresso-BrandHero.png","description":"Button icon URL address","type":"text"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/campaign/instantpush"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"code\": 201,\n \"message\": \"OK\"\n}"},{"id":"1cae1e5c-85bd-4904-b504-965aac6766d5","name":"Bad request","originalRequest":{"method":"POST","header":[{"key":"Ipresso-Token","value":"55ac5b58e5a85babc6e7366eee0d3d6db14d18","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"template","value":"template_key","description":"Template key","type":"text","disabled":true},{"key":"name","value":"name","description":"Instant push name","type":"text"},{"key":"description","value":"description","description":"Instant push description","type":"text"},{"key":"type","value":"webPush","description":"Instant push type","type":"text"},{"key":"wwwId","value":"1","description":"Monitored site ID: the page on which the message will be sent","type":"text"},{"key":"topic","value":"topic_key","description":"Topic key. Topic includes recipients of the message. In order to send a web push to every valid token, send **all** value.","type":"text"},{"key":"key","value":"instant_push_key","description":"Instant push key","type":"text"},{"key":"expirationDate[type]","value":"date","description":"Message validity type","type":"text"},{"key":"expirationDate[date]","value":"2021-11-11 00:00:00","description":"Expiration date after which the message will not be delivered to the recipient who was offline.","type":"text"},{"key":"title","value":"title","description":"Instant push title","type":"text","disabled":true},{"key":"content","value":"content","description":"Instant push content","type":"text"},{"key":"webPush[link]","value":"https://www.ipresso.pl","description":"The address to which the user will be redirected after clicking the notification.","type":"text"},{"key":"webPush[iconUrl]","value":"https://global-uploads.webflow.com/5fb3a8f3ab924c7fbd6705da/5ffb553235288085e0bc9d8d_iPresso-BrandHero.png","description":"Icon URL address","type":"text"},{"key":"webPush[imageUrl]","value":"https://global-uploads.webflow.com/5fb3a8f3ab924c7fbd6705da/5ffb553235288085e0bc9d8d_iPresso-BrandHero.png","description":"Image URL address","type":"text"},{"key":"webPush[buttons][0][label]","value":"button name","description":"Button name","type":"text","disabled":true},{"key":"webPush[buttons][0][link]","value":"button link","description":"The address to which the user will be redirected after clicking the button.","type":"text","disabled":true},{"key":"webPush[buttons][0][iconUrl]","value":"button icon URL","description":"Button icon URL address","type":"text","disabled":true},{"key":"webPush[buttons][0][label]","value":"button name","description":"Button name","type":"text","disabled":true},{"key":"webPush[buttons][0][link]","value":"button link","description":"The address to which the user will be redirected after clicking the button.","type":"text","disabled":true},{"key":"webPush[buttons][0][iconUrl]","value":"button icon URL","description":"Button icon URL address","type":"text","disabled":true}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/campaign/instantpush"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"code\": 400,\n \"message\": \"Bad request - Missing title\"\n}"}],"_postman_id":"ec6fb5d6-add6-4271-9329-6864e7d5630e"},{"name":"Sending instant push (mobile push)","id":"ff7e8f70-5a62-4abc-b572-b94b54d5668a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Ipresso-Token","value":"55ac5b58e5a85babc6e7366eee0d3d6db14d18","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"template","value":"template_key","description":"Template key
\n","type":"text"},{"key":"name","value":"name","description":"Instant push name
\n","type":"text"},{"key":"description","value":"description","description":"Instant push description
\n","type":"text"},{"key":"type","value":"mobilePush","description":"Instant push type
\n","type":"text"},{"key":"appId","value":"application hash","description":"Hash of the application on which the message will be sent
\n","type":"text"},{"key":"topic","value":"topic_key","description":"Topic key. Topic includes recipients of the message. In order to send a mobile push to every valid token, send all value.
\n","type":"text"},{"key":"key","value":"instant_push_key","description":"Instant push key
\n","type":"text"},{"key":"expirationDate","value":"YYYY-MM-DD HH:MM:SS","description":"Expiration date after which the message will not be delivered to the recipient that was offline.
\n","type":"text"},{"key":"title","value":"title","description":"Instant push title
\n","type":"text"},{"key":"content","value":"content","description":"Instant push content
\n","type":"text"},{"key":"mobilePush[applicationActivity]","value":"application activity","description":"Application activity. Required only when applicationActivity value is sent in clickAction parameter.
\n","type":"text"},{"key":"mobilePush[clickAction]","value":"openApplication","description":"Click action. Allows you to choose one of two options: 1) openApplication, 2) applicationActivity
\n","type":"text"},{"key":"mobilePush[additionalData]","value":"{“key”:”value”}","description":"Additional data in JSON format
\n","type":"text"},{"key":"mobilePush[apns]","value":"{“key”:”value”}","description":"Additional data in JSON format for iOS devices
\n","type":"text"},{"key":"expirationDate[type]","value":"date","description":"Message validity type
\n","type":"text"},{"key":"expirationDate[date]","value":"YYYY-MM-DD HH:MM:SS","description":"Expiration date after which the message will not be delivered to the recipient that was offline.
\n","type":"text"},{"key":"expirationDate[type]","value":"periodTime","description":"Message validity interval
\n","type":"text"},{"key":"expirationDate[periodTime][unit]","value":"hours","description":"Time unit
\n","type":"text"},{"key":"expirationDate[periodTime][amount]","value":"24","description":"Amount of hours or days
\n","type":"text"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/campaign/instantpush","description":"In order to send instant push (type: mobile push) via iPresso API, POST request should be sent to the URL:
\n\nCLIENT_PANEL_ADDRESS parameter should be replaced with the iPresso URL address.
If template is not used (template parameter is not sent), required parameters are: name, type, appId, topic, title and content.
\nTemplates can be used by sending template parameter. Filling out additional fields in the body will overwrite template fields.
\nIf all required parameters won’t be sent in the request, code 400 will be returned with a proper message indicating what is missing.
\nThe time type parameter expirationDate [type], during which the message will be delivered to the recipient who is offline, can take 2 values:
\ndate - specifies the expiry date of the message
\nperiodTime - specifies the period of validity of the message
\nWhen selecting the periodTime time interval, you should additionally pass the unit parameter specifying the hours / days units and amount with number of hours / days.
\nBe sure to select only one of the options.
\n","urlObject":{"protocol":"https","path":["api","2","campaign","instantpush"],"host":["CLIENT_PANEL_ADDRESS"],"query":[],"variable":[]}},"response":[{"id":"d8e3ec0b-b62f-4d35-9e44-c45af4c205c5","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Ipresso-Token","value":"55ac5b58e5a85babc6e7366eee0d3d6db14d18","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"template","value":"template_key","description":"Template key","type":"text","disabled":true},{"key":"name","value":"name","description":"Instant push name","type":"text"},{"key":"description","value":"description","description":"Instant push description","type":"text"},{"key":"type","value":"mobilePush","description":"Instant push type","type":"text"},{"key":"appId","value":"application hash","description":"Hash of the application on which the message will be sent","type":"text"},{"key":"topic","value":"topic_key","description":"Topic key. Topic includes recipients of the message. In order to send a mobile push to every valid token, send **all** value.","type":"text"},{"key":"key","value":"instant_push_key","description":"Instant push key","type":"text"},{"key":"expirationDate[type]","value":"date","description":"Message validity type","type":"text"},{"key":"expirationDate[date]","value":"2021-11-11 00:00:00","description":"Expiration date after which the message will not be delivered to the recipient that was offline.","type":"text"},{"key":"title","value":"title","description":"Instant push title","type":"text"},{"key":"content","value":"content","description":"Instant push content","type":"text"},{"key":"mobilePush[applicationActivity]","value":"application activity","description":"Application activity. Required only when applicationActivity value is sent in clickAction parameter.","type":"text"},{"key":"mobilePush[clickAction]","value":"applicationActivity","description":"Click action. Allows you to choose one of two options: 1) openApplication, 2) applicationActivity","type":"text"},{"key":"mobilePush[additionalData]","value":"{“key”:”value”}","description":"Additional data in JSON format","type":"text"},{"key":"mobilePush[apns]","value":"{“key”:”value”}","description":"Additional data in JSON format for iOS devices","type":"text"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/campaign/instantpush"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"code\": 201,\n \"message\": \"OK\"\n}"},{"id":"b0d629b1-3e33-44fe-99ca-47754b738394","name":"Bad request","originalRequest":{"method":"POST","header":[{"key":"Ipresso-Token","value":"55ac5b58e5a85babc6e7366eee0d3d6db14d18","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"template","value":"template_key","description":"Template key","type":"text","disabled":true},{"key":"name","value":"name","description":"Instant push name","type":"text"},{"key":"description","value":"description","description":"Instant push description","type":"text"},{"key":"type","value":"mobilePush","description":"Instant push type","type":"text"},{"key":"appId","value":"application hash","description":"Hash of the application on which the message will be sent","type":"text"},{"key":"topic","value":"topic_key","description":"Topic key. Topic includes recipients of the message. In order to send a mobile push to every valid token, send **all** value.","type":"text"},{"key":"key","value":"instant_push_key","description":"Instant push key","type":"text"},{"key":"expirationDate[type]","value":"date","description":"Message validity type","type":"text"},{"key":"expirationDate[date]","value":"2021-11-11 00:00:00","description":"Expiration date after which the message will not be delivered to the recipient that was offline.","type":"text"},{"key":"title","value":"title","description":"Instant push title","type":"text","disabled":true},{"key":"content","value":"content","description":"Instant push content","type":"text"},{"key":"mobilePush[applicationActivity]","value":"application activity","description":"Application activity. Required only when applicationActivity value is sent in clickAction parameter.","type":"text"},{"key":"mobilePush[clickAction]","value":"applicationActivity","description":"Click action. Allows you to choose one of two options: 1) openApplication, 2) applicationActivity","type":"text"},{"key":"mobilePush[additionalData]","value":"{“key”:”value”}","description":"Additional data in JSON format","type":"text"},{"key":"mobilePush[apns]","value":"{“key”:”value”}","description":"Additional data in JSON format for iOS devices","type":"text"},{"key":"expirationDate[type]","value":"periodTime","description":"Message validity interval","type":"text","disabled":true},{"key":"expirationDate[periodTime][unit]","value":"hours","description":"Time unit","type":"text","disabled":true},{"key":"expirationDate[periodTime][amount]","value":"24","description":"Amount of hours or days","type":"text","disabled":true}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/campaign/instantpush"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"code\": 400,\n \"message\": \"Bad request - Missing title\"\n}"}],"_postman_id":"ff7e8f70-5a62-4abc-b572-b94b54d5668a"},{"name":"Sending WhatsApp campaign","id":"b5ad4c47-9b03-4abd-80e9-35fed1377768","request":{"method":"POST","header":[{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"campaignKey","value":"API_KEY","type":"text","description":"Campaign API key
\n"},{"key":"content[ext]","value":"DATA","type":"text","description":"Variable content
\n"},{"key":"contactId[0]","value":"ID_CONTACT","type":"text","description":"Contact ID
\n"},{"key":"contactId[1]","value":"ID_CONTACT","type":"text","description":"ID kontaktu
\n","disabled":true}]},"url":"https://CLIENT_PANEL_ADRESS/api/2/campaign/whatsapp?returnId=1 ","description":"In order to send Whatsapp campaign via iPresso API, POST request should be sent to the URL:
\n\n\n\nParameter
\nCLIENT_PANEL_ADDRESSshould be replaced with the iPresso URL address.
\n\nThe
\nreturnIdparameter can accept the values 0 or 1, depending on whether we want to receive the idMessage parameter with the ID of the sent message in response or not. This value increases with each unique contact to whom the campaign was sent.
The campaign can be sent to contacts based on their ipresso ID.
\nThe content can be modified using defined variables when creating a campaign. In the example, for the defined variable {_ext_} used in the campaign creator, the DATA value was passed.
E-mail address
\n","type":"text"},{"key":"contactId[0]","value":"ID_CONTACT","description":"Contact ID number
\n","type":"text"},{"key":"content[HEAD]","value":"HEAD_CONTENT","description":"Header content
\n","type":"text"},{"key":"content[TEXT]","value":"TEXT_CONTENT","description":"Message content
\n","type":"text"},{"key":"files[0][url]","value":"https://example.com/attachment.pdf","description":"Attachment URL Link
\n","type":"text"},{"key":"files[0][name]","value":"attachment.pdf","description":"Attachment name
\n","type":"text"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/campaign/ID/send","description":"In order to send message via iPresso API, POST request should be sent to the URL:
https://CLIENT_PANEL_ADDRESS/api/2/campaign/ID/send using campaign ID
\nhttps://CLIENT_PANEL_ADDRESS/api/2/campaign/API_KEY/send?key=true using campaign API key
\nImportant : sending a campain with attachment requires prior contact to arrange shipments for attachments
\n\n\nParameter
\nCLIENT_PANEL_ADDRESSshould be replaced with the URL address of one’s iPresso.
\n\nParameter
\nIDshould be replaced with the campaign ID.
\n\nParameter
\nAPI_KEYshould be replaced with the campaign API key.
You can send messages only to existing iPresso contacts, using the contact’s email email and contact’s ID contactId. Only one field is required; it is not necessary to fill in both.
You can use brackets in campaign content. For example, to replace brackets {_bracket1_} and {_bracket2_}, you need to use [‘content’][‘bracket1’] = ‘Hi’ and [‘content’][‘bracket2’] = ‘this is bracket content’.
In order to return message ID, append returnId=true parameter to the URL address. Examples:
https://CLIENT_PANEL_ADDRESS/api/2/campaign/ID/send?returnId=true
\nhttps://CLIENT_PANEL_ADDRESS/api/2/campaign/KEY_NAME/send?key=true&returnId=true
\nTo check the validation of external attachments, you need to add one of the two GET parameters to the URL:
\n?validate_attachments=true
?validate_attachments=1
Examples:
\nhttps://CLIENT_PANEL_ADDRESS/api/2/campaign/ID/send?validate_attachments=1
\nhttps://CLIENT_PANEL_ADDRESS/api/2/campaign/ID/send?validate_attachments=true
\nThe ID of the message to check. eg. 539034
\n","type":"text","uuid":"acca8aa7-1a8c-46ae-834e-d86d07c13637"},{"key":"messageIds[1]","value":"idMessage","description":"The ID of the message to check.
\n","type":"text","uuid":"b3ec2aa5-cca4-4917-84db-a9a6a90f06d6"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/campaign/TYPE/message/status","description":"The CLIENT_PANEL_ADDRESS parameter should be replaced with the iPresso URL.
The TYPE parameter should be replaced with one of the following sending types:
sms
\nvoice
\nIn the body, the idMessage parameter should be replaced with the message ID, which will be returned after executing a request to the message sending resources using the parameter returnId=true. For example:
\nhttps://CLIENT_PANEL_ADDRESS/api/2/campaign/[Campaign_ID]/send?returnId=true
After executing the request to check the message status, two status responses are possible:
\ndelivered - confirmed delivery
\nno_delivery_confirmation - no confirmed delivery (applies to all cases other than confirmed delivery, including, for example, cancellation)
\nThe maximum number of messageIds in a single request is 100.
\n","urlObject":{"protocol":"https","path":["api","2","campaign","TYPE","message","status"],"host":["CLIENT_PANEL_ADDRESS"],"query":[],"variable":[]}},"response":[{"id":"04ada8eb-7a52-475e-b870-c037cf66259c","name":"Success Delivered","originalRequest":{"method":"POST","header":[{"key":"User-Agent","value":"iPresso","type":"text"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9","type":"text"},{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"messageIds[0]","value":"idMessage","description":"The ID of the message to check.","type":"text","uuid":"50f22b9f-4363-47cb-ac23-8171a17eed7d"},{"key":"messageIds[1]","value":"idMessage","description":"The ID of the message to check.","type":"text","uuid":"4688001f-5ac7-461d-847e-8624d8219897"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/campaign/TYPE/message/status"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"data\": [\n {\n \"messageId\": 538978,\n \"status\": \"no_delivery_confirmation\",\n \"campaignId\": 13005\n },\n {\n \"messageId\": 539031,\n \"status\": \"delivered\",\n \"campaignId\": 13024\n }\n ],\n \"message\": \"OK\"\n}"},{"id":"c4ab72dc-137f-4d77-8d49-22ca5652260a","name":"Error","originalRequest":{"method":"POST","header":[{"key":"User-Agent","value":"iPresso","type":"text"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9","type":"text"},{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"messageIds[0]","value":"idMessage","description":"The ID of the message to check.","type":"text","uuid":"cae8b49c-68b4-44f6-a5a5-407a21a61920"},{"key":"messageIds[1]","value":"idMessage","description":"The ID of the message to check.","type":"text","uuid":"5b2fb697-aece-4983-943a-6cdd08314adf"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/campaign/TYPE/message/status"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"data\": [],\n \"message\": \"OK\"\n}"}],"_postman_id":"6bca4fbb-5ae5-44cc-8123-705b94c1ae34"}],"id":"93e3d443-fccc-8a61-495a-e5182f3a59e9","_postman_id":"93e3d443-fccc-8a61-495a-e5182f3a59e9","description":""},{"name":"Scenarios","item":[{"name":"Scenario launch","id":"7f2fd3d6-9a2c-4b29-a677-b18aeca9f391","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"data[HEAD]","value":"HEAD_CONTENT"},{"key":"data[TEXT]","type":"text","value":"TEXT_CONTENT"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/scenario/KEY/start","description":"In order to launch scenario via iPresso API, POST request should be sent to the URL: https://CLIENT_PANEL_ADDRESS/api/2/scenario/KEY/start
Launching is only possible for scenarios that allow such an action in their configuration. Before the first launch, the scenario must be activated by the client panel. After each hold of receiving contacts, the scenario can be relaunch.
\nParameter CLIENT_PANEL_ADDRESS should be replaced with the URL address of one's iPresso.
Parameter KEY should be replaced with the scenario's API key.
You can use brackets in scenario campaign content. For example, to replace brackets {_bracket1_} and {_bracket2_}, you need to use data[HEAD] = ‘Hi’, data[TEXT] = ‘this is bracket content’
In order to hold scenario via iPresso API, POST request should be sent to the URL: https://CLIENT_PANEL_ADDRESS/api/2/scenario/KEY/hold
Action is only possible for scenarios that allow it in their configuration. After each hold of receiving contacts, the scenario can be relaunch.
\nParameter CLIENT_PANEL_ADDRESS should be replaced with the URL address of one's iPresso.
Parameter KEY should be replaced with the scenario's API key.
In order to add contacts to scenario via iPresso API, POST request should be sent to the url: https://CLIENT_PANEL_ADDRESS/api/2/scenario/KEY/contact
Parameter CLIENT_PANEL_ADDRESS should be replaced with the campaign ID.
Parameter KEY should be replaced with scenario's API key.
In the contact array you can provide IDs of those contacts that you want to add to the scenario.
In the contactData array you can provide contact IDs along with additional data that will be available in the scenario.
The method returns an array of contact id numbers that have been added to the scenario. It is possible that a contact will not be added due to the limit being exceeded and because it was in the scenario (one-time) or is currently in it (recurring). In this case, the returned array will be reduced by those contacts that have not been added to the algorithm again.
\n","urlObject":{"protocol":"https","path":["api","2","scenario","KEY","contact"],"host":["CLIENT_PANEL_ADDRESS"],"query":[],"variable":[]}},"response":[{"id":"26ece808-568c-4e2a-b7ff-5868e6eca250","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"contact[1]","value":"ID_CONTACT","type":"text"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/scenario/KEY/contact"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"55","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Fri, 06 Oct 2017 10:33:21 GMT","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"5ru4jlnfi6pmao3os1q84vnc45","key":"PHPSESSID"}],"responseTime":null,"body":"{\n \"code\": 200,\n \"data\": {\n \"contact\": [\n \"ID_CONTACT\"\n ]\n },\n \"message\": \"OK\"\n}"},{"id":"c7c374f1-8d96-4831-a198-8e8dcc45476f","name":"Not Found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"contact[0]","value":"ID_CONTACT"},{"key":"contact[1]","value":"ID_CONTACT","type":"text"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/scenario/KEY/contact"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"49","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Fri, 06 Oct 2017 10:23:37 GMT","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"5ru4jlnfi6pmao3os1q84vnc45","key":"PHPSESSID"}],"responseTime":null,"body":"{\"code\":404,\"message\":\"Not Found\",\"errorCode\":99}"},{"id":"ef756ae0-408e-42fd-aa8b-1e60aab21054","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"User-Agent","value":"iPresso"},{"key":"Ipresso-Token","value":"72d5b935a85b6e7366ddd0d3b6db14c9"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"contact[0]","value":"ID_CONTACT"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/scenario/KEY/contact"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"51","description":""},{"key":"Content-Type","value":"text/json;charset=UTF-8","description":""},{"key":"Date","value":"Fri, 06 Oct 2017 10:21:48 GMT","description":""},{"key":"X-Content-Type-Options","value":"nosniff","description":""}],"cookie":[{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":false,"domain":"encja-uptest.ipresso.pl","path":"/","secure":false,"value":"5ru4jlnfi6pmao3os1q84vnc45","key":"PHPSESSID"}],"responseTime":null,"body":"{\"code\":400,\"message\":\"Bad Request\",\"errorCode\":13}"}],"_postman_id":"0c8a5b2b-ab7b-45ae-86f0-d07ba550ca5d"}],"id":"31bfbf08-d971-4e08-8d8d-b988e13ca1bf","_postman_id":"31bfbf08-d971-4e08-8d8d-b988e13ca1bf","description":""},{"name":"NPS","item":[{"name":"Save Answer","id":"cf56a8be-f413-4e35-b192-e6a56a79eea0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Ipresso-Token","value":"55ac5b58e5a85babc6e7366eee0d3d6db14d18","type":"text"}],"body":{"mode":"formdata","formdata":[{"description":"score
\n","key":"score","type":"text","value":"10"},{"description":"answer content
\n","key":"answer","type":"text","value":"answer"},{"description":"contact ID
\n","key":"id_contact","type":"text","value":"1"},{"description":"anonymous contact ID
\n","key":"id_contact_anonymous","type":"text","value":"2"}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/nps/KEY/answer","description":"In order to save answers in NPS survey, POST request should be sent to the URL:https://CLIENT_PANEL_ADDRESS/api/2/nps/KEY/answer
\n\nParameter
\nCLIENT_PANEL_ADDRESSshould be replaced with the iPresso URL address.
\n\nParameter
\nKEYshould be replaced with the NPS survey API key.
We use the call only for one type of contact.
\n","urlObject":{"protocol":"https","path":["api","2","nps","KEY","answer"],"host":["CLIENT_PANEL_ADDRESS"],"query":[],"variable":[]}},"response":[{"id":"1ffc7e31-107a-4246-a65f-c931fb197799","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Ipresso-Token","value":"55ac5b58e5a85babc6e7366eee0d3d6db14d18","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"score","value":"10","description":"Wynik","type":"text"},{"key":"answer","value":"answer","description":"Treść odpowiedzi","type":"text"},{"key":"id_contact","value":"1","description":"ID kontaktu","type":"text"},{"key":"id_contact_anonymous","value":"2","description":"ID kontaktu anonimowego","type":"text","disabled":true}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/nps/KEY/answer"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"message\": \"OK\"\n}"},{"id":"f9d0766a-c33e-4ac6-adca-ae3a541baaa0","name":"Bad request","originalRequest":{"method":"POST","header":[{"key":"Ipresso-Token","value":"55ac5b58e5a85babc6e7366eee0d3d6db14d18","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"score","value":"-1","description":"Wynik","type":"text"},{"key":"answer","value":"answer","description":"Treść odpowiedzi","type":"text"},{"key":"id_contact","value":"1","description":"ID kontaktu","type":"text"},{"key":"id_contact_anonymous","value":"2","description":"ID kontaktu anonimowego","type":"text","disabled":true}]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/nps/KEY/answer"},"status":"Bad Request","code":400,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"code\": 400,\n \"message\": \"invalid nps score\"\n}"}],"_postman_id":"cf56a8be-f413-4e35-b192-e6a56a79eea0"},{"name":"Get NPS data","id":"ddd2e3d6-fdac-4a78-a451-46c47fd5831e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"","description":"In order to get data from NPS survey using API, GET request should be sent to the URL:\nhttps://CLIENT_PANEL_ADDRESS/api/2/nps/KEY
\n\nParameter
\nCLIENT_PANEL_ADDRESSshould be replaced with the iPresso URL address.
\n\nParameter
\nKEYshould be replaced with the NPS survey API key.
Please note that only the active survey data can be downloaded.
\n","urlObject":{"query":[],"variable":[]}},"response":[{"id":"f43061c9-857f-49f9-bf53-74142f5bc37c","name":"Success","originalRequest":{"method":"GET","header":[{"key":"IPRESSO_TOKEN","value":"55ac5b58e5a85babc6e7366eee0d3d6db14d18","type":"text"},{"key":"USER_AGENT","value":"iPresso","type":"text"}],"body":{"mode":"formdata","formdata":[]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/nps/KEY"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"data\": {\n \"welcomeScreen\": {\n \"isVisible\": true,\n \"title\": \"Title\",\n \"subtitle\": \"Subtitle\",\n \"buttonLabel\": \"Button label\",\n \"imageUrl\": \"https://global-uploads.webflow.com/6006a52092ce666865e5bf13/6006a52092ce66f982e5c174_iPresso-BrandHero.png\",\n \"imageAlt\": \"Alternative text\"\n },\n \"survey\": {\n \"question\": \"Question\",\n \"questionDescription\": \"Description of the question\",\n \"scoringScaleDescription\": {\n \"smallestValue\": \"The smallest value\",\n \"greatestValue\": \"The greatest value\"\n },\n \"buttonLabel\": \"Button label\",\n \"additionalQuestions\": [\n {\n \"range\": {\n \"from\": 0,\n \"to\": 6\n },\n \"question\": \"Question 1\"\n },\n {\n \"range\": {\n \"from\": 7,\n \"to\": 8\n },\n \"question\": \"Question 2\"\n },\n {\n \"range\": {\n \"from\": 9,\n \"to\": 10\n },\n \"question\": \"Question 3\"\n }\n ]\n },\n \"thankYouScreen\": {\n \"mainText\": \"Title\",\n \"additionalText\": \"Subtitle\",\n \"imageUrl\": \"https://global-uploads.webflow.com/6006a52092ce666865e5bf13/6006a52092ce66f982e5c174_iPresso-BrandHero.png\",\n \"imageAlt\": \"Alternative text\"\n },\n \"appearance\": {\n \"font\": \"Arial\",\n \"color\": \"#e53935\",\n \"customStyles\": \"\\n#welcomeScreenContainer {\\n /* Welcome Screen Main Container /\\n}\\n\\n#welcomeScreenImgBox {\\n / Welcome Screen Image /\\n}\\n\\n#welcomeScreenTitle {\\n / Welcome Screen Title /\\n}\\n\\n#welcomeScreenSubtitle {\\n / Welcome Screen Subtitle /\\n}\\n\\n#welcomeScreenButtonBox button {\\n / Welcome Screen Button /\\n}\\n\\n#surveyContainer {\\n / Survey Main Container /\\n}\\n\\n#surveyQuestionText {\\n / Survey Main Question /\\n}\\n\\n#questionDescriptionText {\\n / Survey Question Description /\\n}\\n\\n#surveyScoreContainer {\\n / Survey Score Container /\\n}\\n\\n.nps-score.buttons {\\n / Survey Nps Score Buttons /\\n}\\n\\n#surveyDescriptionScoreBox {\\n / Survey Scores Description*/\\n}\\n\\n#smallestValue {\\n /* Survey Left Score Description /\\n}\\n\\n#greatestValue {\\n / Survey Right Score Description /\\n}\\n\\n#additionalQuestion{\\n / Survey Additional Question container*/\\n}\\n\\n#surveyAdditionalQuestionText {\\n /* Survey Additional Question /\\n}\\n\\n#surveyButtonBox #button {\\n / Survey Button /\\n}\\n\\n#thankYouScreenContainer {\\n / Thank You Screen Main Container /\\n}\\n\\n#thankYouScreenImgBox {\\n / Thank You Screen Image /\\n}\\n\\n#thankYouScreenTitle {\\n / Thank You Screen Title /\\n}\\n\\n#thankYouScreenAdditionalText {\\n / Thank You Screen Subtitle */\\n}\\n\"\n }\n },\n \"message\": \"OK\"\n}"},{"id":"0e9777bb-18dc-4958-b314-8686ae4cacbb","name":"Bad request","originalRequest":{"method":"GET","header":[{"key":"IPRESSO_TOKEN","value":"55ac5b58e5a85babc6e7366eee0d3d6db14d18","type":"text"},{"key":"USER_AGENT","value":"iPresso","type":"text"}],"body":{"mode":"formdata","formdata":[]},"url":"https://CLIENT_PANEL_ADDRESS/api/2/nps/wrong_api_key"},"status":"Bad request","code":400,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"code\": 400,\n \"message\": \"\"\n}"}],"_postman_id":"ddd2e3d6-fdac-4a78-a451-46c47fd5831e"}],"id":"75e32125-f41f-47a1-a0f5-dbeff345a19b","_postman_id":"75e32125-f41f-47a1-a0f5-dbeff345a19b","description":""},{"name":"Forms","item":[{"name":"Save Form Fill","id":"d82b9adc-70bc-4151-b53d-19282f9bd17d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Ipresso-Token","value":"55ac5b58e5a85babc6e7366eee0d3d6db14d18","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"fields\": {\r\n \"a_email\": \"example@example.com\",\r\n \"a_fname\": \"Jhon\",\r\n \"c_agreement\": true,\r\n \"another_form_field\": \"answear example\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://CLIENT_PANEL_ADDRESS/api/2/form/FORM_KEY/fill","description":"In order to save form fill, POST request should be sent to the URL:https://CLIENT_PANEL_ADDRESS/api/2/form/FORM_KEY/fill
\n\nParameter
\nCLIENT_PANEL_ADDRESSshould be replaced with the iPresso URL address.
\n\nParameter
\nFORM_KEYshould be replaced with the form API key.
Accounts with v1 monitoring or \"v1 + v2 transition mode\" Both the pixel and the contactHash are returned.
Accounts with v2 monitoring only: Only the contactHash is returned.
In the body of the request, include the data of the completed form:
\n{\n \"fields\": {\n \"FORM_FIELD_KEY\": FORM_FIELD_FILL_VALUE\n }\n}\n\n\n\n\n
FORM_FIELD_KEYThe API key of the form field (preview available in the iPresso panel).
\n\n\n
FORM_FIELD_FILL_VALUEThe specific value to be saved in the field.
\n\nThe ability to track a contact in the browser will only be possible after it has been tracked.
\n
\n\nTo do this, display a tracking pixel to the contact in the browser (in the form of an image in the
\nIMG. The pixel address is returned in the pixel field.
\n\nAll returned contact tracking data is immutable and can be saved to avoid the need to re-download it. Monitoring should occur whenever possible upon each login or return to the website, as the user may change browsers or devices.
\n
\n\nThe ability to track a contact in the browser will only be possible after it has been monitored.
\n
\n\nTo do this, use the setContactId method: https://js-api-doc.ipresso.pl/methods/identification/set-contact-id
\n
\n\nPass the value returned in the
\ncontactHashfield as a parameter to this method.
\n\nAll returned contact tracking data is immutable and can be saved to avoid the need to re-download it. Monitoring should occur whenever possible upon each login or return to the website, as the user may change browsers or devices.
\n
Content -> Forms -> Active -> API call manual.API requests are rate-limited within a time window. The default limit is 1000 requests per 10 seconds for whole iPresso Account. If you require different settings, please contact iPresso support.
\nIf this limit is exceeded, the main error code will be 429 with a detailed error code of 122.
\n","_postman_id":"77548344-bc52-427d-92c5-10fe23e12758"},{"name":"Error Codes","item":[],"id":"ca39afbd-6d1d-cdde-c196-a82d07d9524a","description":"