Last modified by Rayaan Ahmed on 2025/02/09 22:20
From version 10.1
edited by Rayaan Ahmed
on 2024/02/27 18:43
Change comment: There is no comment for this version
To version 9.1
edited by Rayaan Ahmed
on 2024/02/26 11:24
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -65,6 +65,7 @@
65 65  11. Add users to segment
66 66  11. Get all segment ids for a user
67 67  
68 +
68 68  (% class="western" %)
69 69  **Accessing API**
70 70  
... ... @@ -95,6 +95,7 @@
95 95  Any JSON data or JSON files containing information needed for requests, such as updating a record with new information.
96 96  )))
97 97  
99 +
98 98  (% class="western" %)
99 99  **General API Usage**
100 100  
... ... @@ -1623,6 +1623,7 @@
1623 1623  JSON of the Questions type object needs to be sent as post data. Id field is mandatory for update.
1624 1624  )))
1625 1625  
1628 +
1626 1626  (% id="HGETAllQuestions" style="margin-left: 0.0px;" class="sc-fznLPX cxTVKx" %)
1627 1627  == (% class="imuBmi sc-fzoaKM" style="color:#007f31" %)GET (% class="documentation-core-item-request-name jbmEtY sc-fzomuh" style="color:#212121" %)All Questions(%%) ==
1628 1628  
... ... @@ -8319,6 +8319,7 @@
8319 8319  {"ProductID":"65","ResourceID":”121"}
8320 8320  )))
8321 8321  
8325 +
8322 8322  (% id="HGETAllProducts" style="margin-left: 0.0px;" class="sc-fznLPX cxTVKx" %)
8323 8323  == (% class="imuBmi sc-fzoaKM" style="color:#007f31" %)GET (% class="documentation-core-item-request-name jbmEtY sc-fzomuh" style="color:#212121" %)All Products(%%) ==
8324 8324  
... ... @@ -9072,6 +9072,7 @@
9072 9072  JSON of the terms type object needs to be sent as post data. Id field is mandatory for update.
9073 9073  )))
9074 9074  
9079 +
9075 9075  (% id="HGETAllTerms" style="margin-left: 0.0px;" class="sc-fznLPX cxTVKx" %)
9076 9076  == (% class="imuBmi sc-fzoaKM" style="color:#007f31" %)GET (% class="documentation-core-item-request-name jbmEtY sc-fzomuh" style="color:#212121" %)All Terms(%%) ==
9077 9077  
... ... @@ -9677,6 +9677,7 @@
9677 9677  JSON of the resources type object needs to be sent as post data. Id field is mandatory for update.
9678 9678  )))
9679 9679  
9685 +
9680 9680  (% id="HGETAllResources" style="margin-left: 0.0px;" class="sc-fznLPX cxTVKx" %)
9681 9681  == (% class="imuBmi sc-fzoaKM" style="color:#007f31" %)GET (% class="documentation-core-item-request-name jbmEtY sc-fzomuh" style="color:#212121" %)All Resources(%%) ==
9682 9682  
... ... @@ -10219,6 +10219,7 @@
10219 10219  JSON of the Sources type object needs to be sent as post data. Id field is mandatory for update.
10220 10220  )))
10221 10221  
10228 +
10222 10222  (% id="HGETAllSourcecodes" style="margin-left: 0.0px;" class="sc-fznLPX cxTVKx" %)
10223 10223  == (% class="imuBmi sc-fzoaKM" style="color:#007f31" %)GET (% class="documentation-core-item-request-name jbmEtY sc-fzomuh" style="color:#212121" %)All Source codes(%%) ==
10224 10224  
... ... @@ -10799,6 +10799,7 @@
10799 10799  JSON of the Transactions type object needs to be sent as post data. Id field should not be sent.
10800 10800  )))
10801 10801  
10809 +
10802 10802  (% id="HGETAllTransactions" style="margin-left: 0.0px;" class="sc-fznLPX cxTVKx" %)
10803 10803  == (% class="imuBmi sc-fzoaKM" style="color:#007f31" %)GET (% class="documentation-core-item-request-name jbmEtY sc-fzomuh" style="color:#212121" %)All Transactions(%%) ==
10804 10804  
... ... @@ -12886,6 +12886,7 @@
12886 12886  Parameters required to add user to the engagement needs to be sent as post data in JSON format.
12887 12887  )))
12888 12888  
12897 +
12889 12889  (% id="HGETAllEngagements" style="margin-left: 0.0px;" class="sc-fznLPX cxTVKx" %)
12890 12890  == (% class="imuBmi sc-fzoaKM" style="color:#007f31" %)GET (% class="documentation-core-item-request-name jbmEtY sc-fzomuh" style="color:#212121" %)All Engagements(%%) ==
12891 12891  
... ... @@ -13364,8 +13364,8 @@
13364 13364  
13365 13365  ----
13366 13366  
13367 -{{code language="yml" title="Body"}}
13368 -{"engagement id":"e0e816ec-77ba-4db1-bfc0-22d340337357","name":"Webinar_1","ocid":"1845775", "date":"2023-12-31 14:12:38", "data":{"price":"10","attendance_status":"not_attended"},"segment":{}}
13376 +{{code language="yml" theme="RDark" title="Body"}}
13377 +{"engagement id":"e0e816ec-77ba-4db1-bfc0-22d340337357","show id":"Webinar_1","ocid":"1845775", "date":"2023-12-31 14:12:38", "data":{"price":"10","attendance_status":"not_attended"},"segment":{}}
13369 13369  {{/code}}
13370 13370  
13371 13371  ==== Example ====
... ... @@ -13374,7 +13374,7 @@
13374 13374  
13375 13375  (% style="color:#6b6b6b" %)Request
13376 13376  
13377 -{{code language="php" title="Add User to Engagement Request"}}
13386 +{{code language="php" theme="RDark" title="Add User to Engagement Request"}}
13378 13378   <?php
13379 13379  
13380 13380  $curl = curl_init();
... ... @@ -13388,7 +13388,7 @@
13388 13388   CURLOPT_FOLLOWLOCATION => true,
13389 13389   CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
13390 13390   CURLOPT_CUSTOMREQUEST => 'POST',
13391 - CURLOPT_POSTFIELDS =>'{"engagement id":"e0e816ec-77ba-4db1-bfc0-22d340337357","name":"Webinar_1","ocid":"1845775", "date":"2023-12-31 14:12:38", "data":{"price":"10","attendance_status":"not_attended"},"segment":{}}',
13400 + CURLOPT_POSTFIELDS =>'{"engagement id":"e0e816ec-77ba-4db1-bfc0-22d340337357","show id":"Webinar_1","ocid":"1845775", "date":"2023-12-31 14:12:38", "data":{"price":"10","attendance_status":"not_attended"},"segment":{}}',
13392 13392   CURLOPT_HTTPHEADER => array(
13393 13393   'Appkey: {{ONECOUNT API KEY}}'
13394 13394   ),
... ... @@ -13559,6 +13559,7 @@
13559 13559  Get all segment user has be subscribed based on user id.
13560 13560  )))
13561 13561  
13571 +
13562 13562  (% id="HGETAllSegments" style="margin-left: 0.0px;" class="sc-fznLPX cxTVKx" %)
13563 13563  == (% class="imuBmi sc-fzoaKM" style="color:#007f31" %)GET (% class="documentation-core-item-request-name jbmEtY sc-fzomuh" style="color:#212121" %)All Segments(%%) ==
13564 13564  
... ... @@ -14046,6 +14046,7 @@
14046 14046  JSON of the Telemarketing type object needs to be sent as post data. Id field should not be sent.
14047 14047  )))
14048 14048  
14059 +
14049 14049  (% class="western" %)
14050 14050  POST method can be used to create telemarketing stat. Telemarketing info needs to be sent as request and an Id will be returned when the transaction is created.
14051 14051  
... ... @@ -14160,6 +14160,7 @@
14160 14160  Returns telemarketing ids of the newly created transaction. If multiple stats are sent, multiple ids are returned in cvs format.
14161 14161  )))
14162 14162  
14174 +
14163 14163  (% class="western" %)
14164 14164  **API REFERENCE**
14165 14165  
... ... @@ -14254,6 +14254,7 @@
14254 14254  )))
14255 14255  
14256 14256  
14269 +
14257 14257  (% class="western" %)
14258 14258  **Type: Choices**
14259 14259  
... ... @@ -14337,6 +14337,7 @@
14337 14337  Tied to which question id.
14338 14338  )))
14339 14339  
14353 +
14340 14340  (% class="western" %)
14341 14341  **Type: Users**
14342 14342  
... ... @@ -14407,6 +14407,7 @@
14407 14407  Request date.
14408 14408  )))
14409 14409  
14424 +
14410 14410  (% class="western" %)
14411 14411  **Type: Demo**
14412 14412  
... ... @@ -14464,6 +14464,7 @@
14464 14464  ...
14465 14465  )))
14466 14466  
14482 +
14467 14467  (% class="western" %)
14468 14468  **Type: Transactions**
14469 14469  
... ... @@ -14651,6 +14651,7 @@
14651 14651  If there is amount (USD) included in transaction.
14652 14652  )))
14653 14653  
14670 +
14654 14654  (% class="western" %)
14655 14655  **Type: Sources**
14656 14656  
... ... @@ -14721,6 +14721,7 @@
14721 14721  If this is a child source then list the parent source id.
14722 14722  )))
14723 14723  
14741 +
14724 14724  (% class="western" %)
14725 14725  **Type: Products**
14726 14726  
... ... @@ -14791,6 +14791,7 @@
14791 14791  (Array of) Terms associated with the product.
14792 14792  )))
14793 14793  
14812 +
14794 14794  (% class="western" %)
14795 14795  **Type: Terms**
14796 14796  
... ... @@ -14900,6 +14900,7 @@
14900 14900  If there is price (USD) for the term.
14901 14901  )))
14902 14902  
14922 +
14903 14903  (% class="western" %)
14904 14904  **Type: Resources**
14905 14905  
... ... @@ -15043,6 +15043,7 @@
15043 15043  Default value is 0. This parameter is used to provide access to protected content.
15044 15044  )))
15045 15045  
15066 +
15046 15046  (% class="western" %)
15047 15047  **Type: Telemarketing**
15048 15048  
... ... @@ -15159,3 +15159,4 @@
15159 15159  If the page url already exists and it doesn't match with the one that is being sent then it will throw conflict error with the title in our system.
15160 15160  )))
15161 15161  
15183 +