-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathwebsitescrapeModifiedHTML.html
More file actions
2178 lines (1831 loc) · 121 KB
/
websitescrapeModifiedHTML.html
File metadata and controls
2178 lines (1831 loc) · 121 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
def notimplementedinameaningfulwayyet(sorry):
class Authentication(object):
"""Authentication
<p>The Infusionsoft XML-RPC API uses a fairly standard implementation of OAuth 2.0 in order to provide authentication to all API endpoints. In the past, the Infusionsoft API has relied on a simple token based system; while those tokens will remain active until some date in the future, any new implementations will be required to use OAuth for all requests. Rather than re-explain OAuth again, it is more useful to provide a series of documents that have already been created and demonstrate the OAuth protocol, how to implement it in your code, how to troubleshoot, and how to ease development. Before that, though, it is important to have the authorization destinations and necessary details.</p>
"""
["Authentication"].request-permission():
<h4>Arguments</h4>
<b>client_id:</b> string (required)
<p>Application client ID </p>
<b>redirect_uri:</b> string (required)
<p>This is the callback URL that Infusionsoft will redirect the users back to after authorization (must be HTTPS). The redirect_uri must be a registered URL in your application. We will not redirect users to any other URLs, so it is important this be properly setup before any authentication attempts. </p>
<b>response_type:</b> string (required)
<p>The desired grant type, as per the OAuth 2.0 spec. The only current valid value is response_type=code Defaults to code<br>
<b>scope:</b> string
<p>The scopes required by your application. The only current valid value is scope=full Defaults to full<br>
<h4>Returns</h4>
<p>Once the user has logged into their Infusionsoft account and authorized your application, they will be redirected back to your application at your specified redirect_uri with a code URL parameter that is used to request an access token.</p>
["Authentication"].request-an-access-token():
<h4>Arguments</h4>
<b>client_id:</b> string (required)
<p>Your application's client ID </p>
<b>client_secret:</b> string (required)
<p>Your application's client secret </p>
<b>code:</b> string (required)
<p>The code returned when the user was redirected back to your application </p>
<b>grant_type:</b> string (required)
<p>The desired grant type, as per the OAuth 2.0 spec. The only current valid value is grant_type=authorization_code Defaults to authorization_code<br>
<b>redirect_uri:</b> string (required)
<p>The redirect URL from the original authorization request </p>
<h4>Returns</h4>
<p>The <code>access_token</code> is the token you will use to authenticate requests to the Infusionsoft API, and it expires after the time in the <code>expires_in</code> field (in seconds). In order to get a new valid access token after one has expired, you must use the <code>refresh_token</code> to request a new access token.</p>
["Authentication"].refresh-an-access-token():
<br>
<h4>Arguments</h4>
<b>grant_type:</b> string (required)
<p>The desired grant type, as per the OAuth 2.0 spec. The only current valid value is <code>refresh_token</code> Defaults to refresh_token<br>
<b>refresh_token:</b> string (required)
<p>The refresh token provided when the most recent <code>access_token</code> was granted </p>
<b>Header: Authorization:</b> string (required)
<p>The word "Basic" concatenated with a base64 encoded string of your <code>client_id</code>, a colon, and your <code>client_secret</code> passed via the <code>Authorization</code> header. <br><br>Example pseudo code: <code>'Basic' + base64_encode(CLIENT_ID + ':' + CLIENT_SECRET)</code> </p>
<h4>Returns</h4>
<p>Provides a new <code>access_token</code> that you will use to authenticate subsequent requests to the Infusionsoft API. Like the originally granted token, this expires after the amount of time in the <code>expires_in</code> field (in seconds). You must use the newly provided <code>refresh_token</code> to request a subsequent new access token.
class Affiliate(object):
"""Affiliate
<p>The Affiliate Service is used to pull commission data and activities for affiliates. With this service, you have access to Clawbacks, Commissions, Payouts, Running Totals, and the Activity Summary. The methods in the Affiliate Service mirror the reports produced inside Infusionsoft. To manage affiliate information (ie Name, Phone, etc.) you will need to use the DataService.</p>
"""
["Affiliate"].retrieve-clawbacks():
<h4>Arguments</h4>
<b>privateKey:</b> string (required)
<p>Your Infusionsoft API key </p>
<b>affiliateId:</b> integer (required)
<p>The Id number for the affiliate record you would like the claw backs for </p>
<b>filterStartDate:</b> dateTime (required)
<p>The starting date for the date range which you would like affiliate claw backs for </p>
<b>filterEndDate:</b> dateTime (required)
<p>The ending date for the date range which you would like the affiliate claw backs for </p>
args = {
"affiliateId" : ""
"filterStartDate" : ""
"filterEndDate" : ""
}
ISServer.APIAffiliateService(affClawbacks, args)
["Affiliate"].retrieve-commissions():
<h4>Arguments</h4>
<b>privateKey:</b> string (required)
<p>Your Infusionsoft API key </p>
<b>affiliateId:</b> integer (required)
<p>The Id number for the affiliate record you would like the commissions for </p>
<b>filterStartDate:</b> dateTime (required)
<p>The starting date for the date range which you would like affiliate commissions for </p>
<b>filterEndDate:</b> dateTime (required)
<p>The ending date for the date range which you would like the affiliate commissions for </p>
args = {
"affiliateId" : ""
"filterStartDate" : ""
"filterEndDate" : ""
}
ISServer.APIAffiliateService(affCommissions, args)
["Affiliate"].retrieve-payments():
<h4>Arguments</h4>
<b>privateKey:</b> string (required)
<p>Your Infusionsoft API key </p>
<b>affiliateId:</b> integer (required)
<p>The Id number for the affiliate record you would like the claw backs for </p>
<b>filterStartDate:</b> dateTime (required)
<p>The starting date for the date range which you would like affiliate payments for </p>
<b>filterEndDate:</b> dateTime (required)
<p>The ending date for the date range which you would like the affiliate payments for </p>
args = {
"affiliateId" : ""
"filterStartDate" : ""
"filterEndDate" : ""
}
ISServer.APIAffiliateService(affPayouts, args)
["Affiliate"].retrieve-redirect-links():
<h4>Arguments</h4>
<b>privateKey:</b> string (required)
<p>Your Infusionsoft API key </p>
<b>affiliateId:</b> integer (required)
<p>The Id number for the affiliate record you would like the redirect links for </p>
args = {
"affiliateId" : ""}
}
ISServer.AffiliateService(getRedirectLinksForAffiliate, args)
["Affiliate"].retrieve-a-summary-of-affiliate-statistics():
<h4>Arguments</h4>
<b>privateKey:</b> string (required)
<p>Your Infusionsoft API key </p>
<b>affiliateId:</b> integer (required)
<p>An array of Affiliate Id numbers you would like stats for </p>
<b>filterStartDate:</b> string (required)
<p>The starting date for the date range which you would like affiliate stats for </p>
<b>filterEndDate:</b> string (required)
<p>The ending date for the date range which you would like the affiliate stats for </p>
args = {
"affiliateId" : ""
"filterStartDate" : ""
"filterEndDate" : ""
}
ISServer.APIAffiliateService(affSummary, args)
["Affiliate"].retrieve-running-totals():
<h4>Arguments</h4>
<b>privateKey:</b> string (required)
<p>Your Infusionsoft API key </p>
<b>affiliateIds:</b> array (required)
<p>An integer array of the affiliate ID numbers that you would like balances for </p>
args = {
"affiliateIds" : ""}
}
ISServer.APIAffiliateService(affRunningTotals, args)
class Affiliate(object):
"""Affiliate
<p>The Affiliate Program Service allows access to some of features in the Referral Partner Center</p>
"""
["Affiliate"].program-retrieve-all-programs():
["Affiliate"].program-retrieve-a-program-s-affiliates():
<h4>Arguments</h4>
<b>privateKey:</b> string (required)
<p>Your Infusionsoft API key </p>
<b>programId:</b> integer (required)
<p>The Referral Partner Commission Program ID </p>
args = {
"programId" : ""}
}
ISServer.AffiliateProgramService(getAffiliatesByProgram, args)
["Affiliate"].program-retrieve-an-affiliate-s-programs():
<h4>Arguments</h4>
<b>privateKey:</b> string (required)
<p>Your Infusionsoft API key </p>
<b>affiliateId:</b> integer (required)
<p>The affiliate you want to get the programs for </p>
args = {
"affiliateId" : ""}
}
ISServer.AffiliateProgramService(getProgramsForAffiliate, args)
["Affiliate"].program-retrieve-program-resources():
<h4>Arguments</h4>
<b>privateKey:</b> string (required)
<p>Your Infusionsoft API key </p>
<b>programId:</b> integer (required)
<p>The commission program you want resources from </p>
args = {
"programId" : ""}
}
ISServer.AffiliateProgramService(getResourcesForAffiliateProgram, args)
class Contact(object):
"""Contact
<p>The Contact service is used to manage contacts. You can add, update and find contacts in addition to managing follow up sequences, tags and action sets.</p>
"""
["Contact"].create-a-contact():
<h4>Arguments</h4>
<b>privateKey:</b> string (required)
<p>Your Infusionsoft API key </p>
<b>data:</b> array (required)
<p>An associative array of the data for this new contact record. The array key is the field name to store the value within </p>
args = {
"data" : ""}
}
ISServer.ContactService(add, args)
["Contact"].create-a-contact-and-check-for-duplicates():
<h4>Arguments</h4>
<b>privateKey:</b> string (required)
<p>Your Infusionsoft API key </p>
<b>data:</b> array (required)
<p>An associative array of the data for this new contact record. The array key is the field name to store the value within. </p>
<b>dupCheckType:</b> string (required)
<p>Determines how to consider a duplicate record. Options are: 'Email', 'EmailAndName', or 'EmailAndNameAndCompany'
args = {
"data" : ""
"dupCheckType" : ""
}
ISServer.ContactService(addWithDupCheck, args)
["Contact"].retrieve-a-contact():
<h4>Arguments</h4>
<b>privateKey:</b> string (required)
<p>Your Infusionsoft API key </p>
<b>contactId:</b> integer (required)
<p>The Id number of the contact you would like to load data from </p>
<b>selectedFields:</b> array (required)
<p>An array of strings where each string is the database field name of the field you would like sent back </p>
args = {
"contactId" : ""
"selectedFields" : ""
}
ISServer.ContactService(load, args)
["Contact"].update-a-contact():
<h4>Arguments</h4>
<b>privateKey:</b> string (required)
<p>Your Infusionsoft API key </p>
<b>contactId:</b> integer (required)
<p>The ID of the contact you wish to update </p>
<b>data:</b> array (required)
<p>An associate array of the data for this contact. The array keys should be the field names you wish to update. </p>
args = {
"contactId" : ""
"data" : ""
}
ISServer.ContactService(update, args)
["Contact"].merge-two-contacts():
<h4>Arguments</h4>
<b>privateKey:</b> string (required)
<p>Your Infusionsoft API key </p>
<b>contactId:</b> integer (required)
<p>The contact ID number you want to merge into </p>
<b>duplicateContactId:</b> integer (required)
<p>The contact ID of the duplicate contact you would like to merge </p>
args = {
"contactId" : ""
"duplicateContactId" : ""
}
ISServer.ContactService(merge, args)
["Contact"].search-for-a-contact-by-an-email-address():
<h4>Arguments</h4>
<b>privateKey:</b> string (required)
<p>Your Infusionsoft API key </p>
<b>email:</b> string (required)
<p>The email address to search with </p>
<b>selectedFields:</b> array (required)
<p>The contact fields you would like returned </p>
args = {
"email" : ""
"selectedFields" : ""
}
ISServer.ContactService(findByEmail, args)
["Contact"].add-a-tag-to-a-contact():
<h4>Arguments</h4>
<b>privateKey:</b> string (required)
<p>Your Infusionsoft API key </p>
<b>contactId:</b> integer (required)
<p>The ID of the contact you would like to add to a group </p>
<b>tagId:</b> integer (required)
<p>The ID of the tag to add to the contact </p>
args = {
"contactId" : ""
"tagId" : ""
}
ISServer.ContactService(addToGroup, args)
["Contact"].remove-a-tag-from-a-contact():
<h4>Arguments</h4>
<b>privateKey:</b> string (required)
<p>Your Infusionsoft API key </p>
<b>contactId:</b> integer (required)
<p>The Id number of the contact you would like to remove the tag from </p>
<b>tagId:</b> integer (required)
<p>The tag ID. This is found on the Setup > Tags menu </p>
<div class="method-example">
args = {
"contactId" : ""
"tagId" : ""
}
ISServer.ContactService(removeFromGroup, args)
["Contact"].add-a-contact-to-a-follow-up-sequence():
<h4>Arguments</h4>
<b>privateKey:</b> string (required)
<p>Your Infusionsoft API key </p>
<b>contactId:</b> integer (required)
<p>The ID of the contact you would like to start the follow-up sequence for. </p>
<b>campaignId:</b> integer (required)
<p>The ID of the follow-up sequence to start the contact on. </p>
args = {
"contactId" : ""
"campaignId" : ""
}
ISServer.ContactService(addToCampaign, args)
["Contact"].retrieve-a-contact-s-next-follow-up-sequence-step():
<h4>Arguments</h4>
<b>privateKey:</b> string (required)
<p>Your Infusionsoft API key </p>
<b>contactId:</b> integer (required)
<p>The Id number of the contact record you would like to get the next sequence step for </p>
<b>followUpSequenceId:</b> integer (required)
<p>The follow-up sequence Id number you would like to get the next step for the given contact </p>
args = {
"contactId" : ""
"followUpSequenceId" : ""
}
ISServer.ContactService(getNextCampaignStep, args)
["Contact"].immediately-execute-a-follow-up-sequence-step-for-multiple-contacts():
<h4>Arguments</h4>
<b>privateKey:</b> string (required)
<p>Your Infusionsoft API key </p>
<b>contactIds:</b> array (required)
<p>An array of contact Id numbers you would like to reschedule the step for </p>
<b>sequenceStepId:</b> integer (required)
<p>The ID of the particular sequence step you would like to reschedule </p>
args = {
"contactIds" : ""
"sequenceStepId" : ""
}
ISServer.ContactService(rescheduleCampaignStep, args)
["Contact"].pause-a-follow-up-sequence-for-a-contact():
<h4>Arguments</h4>
<b>privateKey:</b> string (required)
<p>Your Infusionsoft API key </p>
<b>contactId:</b> integer (required)
<p>The Id number of the contact record you are pausing the sequence on </p>
<b>sequenceId:</b> integer (required)
<p>The follow-up sequence Id number </p>
args = {
"contactId" : ""
"sequenceId" : ""
}
ISServer.ContactService(pauseCampaign, args)
["Contact"].resume-a-follow-up-sequence-for-a-contact():
<h4>Arguments</h4>
<b>privateKey:</b> string (required)
<p>Your Infusionsoft API key </p>
<b>contactId:</b> integer (required)
<p>The ID of the contact you would like to resume the campaign for </p>
<b>seqId:</b> integer (required)
<p>The ID of the follow-up sequence to resume </p>
args = {
"contactId" : ""
"seqId" : ""
}
ISServer.ContactService(resumeCampaignForContact, args)
["Contact"].remove-a-contact-from-a-follow-up-sequence():
<h4>Arguments</h4>
<b>privateKey:</b> string (required)
<p>Your Infusionsoft API key </p>
<b>contactId:</b> integer (required)
<p>The Id number of the contact you want to remove the sequence from </p>
<b>followUpSequenceId:</b> integer (required)
<p>The ID number of the campaign sequence you would like to remove the contact from </p>
args = {
"contactId" : ""
"followUpSequenceId" : ""
}
ISServer.ContactService(removeFromCampaign, args)
["Contact"].run-an-action-set-for-a-contact():
<h4>Arguments</h4>
<b>privateKey:</b> string (required)
<p>Your Infusionsoft API key </p>
<b>contactId:</b> integer (required)
<p>The ID of the contact record you want to run the action set on </p>
<b>actionSetId:</b> integer (required)
<p>The Id number of the action set you would like to run. This is found on the Setup > Action Sets menu
args = {
"contactId" : ""
"actionSetId" : ""
}
ISServer.ContactService(runActionSequence, args)
class Data(object):
"""Data
<p>The Data service is used to manipulate most data in Infusionsoft. It permits you to work on any available tables and has a wide range of uses.
To manage affiliate information (i.e. Name, Phone, etc.) you will need to use the Data service.</p>
"""
["Data"].create-a-record():
<h4>Arguments</h4>
<b>privateKey:</b> string (required)
<p>Your Infusionsoft API key </p>
<b>table:</b> string (required)
<p>The Infusionsoft database table name </p>
<b>values:</b> struct (required)
<p>An associative array of data you would like stored in this new row in the table </p>
<h4>Returns</h4>
<p>Returns an integer representing the ID of the new record.</p>
args = {
"table" : ""
"values" : ""
}
ISServer.DataService(add, args)
["Data"].retrieve-a-record():
<h4>Arguments</h4>
<b>privateKey:</b> string (required)
<p>Your Infusionsoft API key </p>
<b>table:</b> string (required)
<p>Infusionsoft database table name from which you want to load a record </p>
<b>recordID:</b> integer (required)
<p>The unique Id number for the record you would like to load </p>
<b>fields:</b> array (required)
<p>The fields you would like returned from this row in the database </p>
<h4>Returns</h4>
<p>The specified fields for the given record.</p>
args = {
"table" : ""
"recordID" : ""
"fields" : ""
}
ISServer.DataService(load, args)
["Data"].find-a-record-by-matching-a-specific-field():
<h4>Arguments</h4>
<b>privateKey:</b> string (required)
<p>Your Infusionsoft API key </p>
<b>table:</b> string (required)
<p>The Infusionsoft database table name </p>
<b>limit:</b> integer (required)
<p>The number of records you would like returned. The maximum possible is 1000. </p>
<b>page:</b> integer (required)
<p>The page of results you would like returned. The first page is page 0 (loop through pages to get more than 1000 records). </p>
<b>fieldName:</b> string (required)
<p>The name of the field to search on </p>
<b>fieldValue:</b> string (required)
<p>The value stored in the field you would like to search on </p>
<b>returnFields:</b> array (required)
<p>The fields you would like returned from the table you are searching on </p>
<h4>Returns</h4>
<p>Returns one object per result found. The result will contain all fields specified in the request along with their corresponding value.</p>
args = {
"table" : ""
"limit" : ""
"page" : ""
"fieldName" : ""
"fieldValue" : ""
"returnFields" : ""
}
ISServer.DataService(findByField, args)
["Data"].query-a-data-table():
<h4>Arguments</h4>
<b>privateKey:</b> string (required)
<p>Your Infusionsoft API key </p>
<b>table:</b> string (required)
<p>The table to query on </p>
<b>limit:</b> integer (required)
<p>The number of records to retrieve, a maximum of 1000 </p>
<b>page:</b> integer (required)
<p>Page of data to request (in case there are more than 1000 records).Paging starts with 0. </p>
<b>queryData:</b> struct (required)
<p>A struct containing query data. The key is the field to search on, and the value is the data to look for. % is the wild card operator and all searches are case insensitive. If you would like to query for an empty(null) field, use ~null~ in your query parameter, such as ‘FirstName' => ‘~null~' </p>
<b>selectedFields:</b> array (required)
<p>Fields the query should return </p>
<b>orderBy:</b> string
<p>The field which the results should be sorted by </p>
<b>ascending:</b> boolean
<p>Changes the order of results to ascending instead of descending Defaults to false<br>
<h4>Returns</h4>
<p>Returns an array of objects, one per result found by the query. The object will contain all fields specified by the selected fields along with their corresponding values.</p>
args = {
"table" : ""
"limit" : ""
"page" : ""
"queryData" : ""
"selectedFields" : ""
"orderBy" : ""
"ascending" : ""
}
ISServer.DataService(query, args)
["Data"].update-a-record():
<h4>Arguments</h4>
<b>privateKey:</b> string (required)
<p>Your Infusionsoft API key </p>
<b>table:</b> string (required)
<p>The Infusionsoft database table name </p>
<b>recordID:</b> integer (required)
<p>The ID of the record to update </p>
<b>values:</b> struct (required)
<p>An associative array of data to update </p>
<h4>Returns</h4>
<p>Returns an ID of the successfully updated record.</p>
args = {
"table" : ""
"recordID" : ""
"values" : ""
}
ISServer.DataService(update, args)
["Data"].delete-a-record():
<h4>Arguments</h4>
<b>privateKey:</b> string (required)
<p>Your Infusionsoft API key </p>
<b>table:</b> string (required)
<p>The table you would like to delete the record from </p>
<b>ID:</b> integer (required)
<p>The ID of the record to delete </p>
<h4>Returns</h4>
<p>Returns a boolean true if successful; false otherwise.</p>
args = {
"table" : ""
"ID" : ""
}
ISServer.DataService(delete, args)
["Data"].count-a-data-table-s-records():
<h4>Arguments</h4>
<b>privateKey:</b> string (required)
<p>Your Infusionsoft API key </p>
<b>table:</b> string (required)
<p>The table to count the records on </p>
<b>queryData:</b> struct (required)
<p>A struct containing query data. The key is the field to search on, and the value is the data to look for. % is the wild card operator and all searches are case insensitive. If you would like to query for an empty(null) field, use ~null~ in your query parameter, such as ‘FirstName' => ‘~null~' </p>
<h4>Returns</h4>
<p>Returns an integer count of the number of records that match the query.</p>
args = {
"table" : ""
"queryData" : ""
}
ISServer.DataService(count, args)
["Data"].create-a-custom-field():
<h4>Arguments</h4>
<b>privateKey:</b> string (required)
<p>Your Infusionsoft API key </p>
<b>customFieldType:</b> string (required)
<p>Where the custom field will be used inside Infusionsoft. Options include Contact, Company, Affiliate, Task/Appt/Note, Order, Subscription, or Opportunity </p>
<b>displayName:</b> string (required)
<p>The label/name of this new custom field </p>
<b>dataType:</b> string (required)
<p>What type of data this field will support. Text, Dropdown, TextArea, etc. </p>
<b>headerID:</b> integer (required)
<p>The ID of the custom field header you want this field to appear under. Customer headers are located on custom tabs. </p>
<h4>Returns</h4>
<p>Returns the ID of the new field</p>
args = {
"customFieldType" : ""
"displayName" : ""
"dataType" : ""
"headerID" : ""
}
ISServer.DataService(addCustomField, args)
["Data"].update-a-custom-field():
<h4>Arguments</h4>
<b>privateKey:</b> string (required)
<p>Your Infusionsoft API key </p>
<b>customFieldId:</b> integer (required)
<p>ID number of the custom field you would like to update </p>
<b>values:</b> struct (required)
<p>The values for the given custom field </p>
<h4>Returns</h4>
<p>Returns a boolean true if successfully updated.</p>
args = {
"customFieldId" : ""
"values" : ""
}
ISServer.DataService(updateCustomField, args)
["Data"].retrieve-an-appointment-s-icalendar-file():
<h4>Arguments</h4>
<b>privateKey:</b> string (required)
<p>Your Infusionsoft API key </p>
<b>appointmentId:</b> integer (required)
<p>The ID of the appointment to retrieve an iCalendar file for </p>
args = {
"appointmentId" : ""
}
ISServer.DataService(getAppointmentICal, args)
["Data"].retrieve-application-setting():
<h4>Arguments</h4>
<b>privateKey:</b> string (required)
<p>Your Infusionsoft API key </p>
<b>module:</b> string (required)
<p>The application module this setting belongs to </p>
<b>setting:</b> string (required)
<p>The database name of the setting to retrieve </p>
args = {
"module" : ""
"setting" : ""
}
ISServer.DataService(getAppSetting, args)
["Data"].validate-a-user-s-credentials():
<h4>Arguments</h4>
<b>privateKey:</b> string (required)
<p>Your Infusionsoft API key </p>
<b>username:</b> string (required)
<p>The username of the user to validate </p>
<b>passwordHash:</b> string (required)
<p>An MD5 hash of the Infusionsoft user's password </p>
<h4>Returns</h4>
<p>Valid credentials will return a user ID; otherwise returns an error.</p>
args = {
"username" : ""
"passwordHash" : ""
}
ISServer.DataService(authenticateUser, args)
class Discount(object):
"""Discount
<p>The Discount service is used to manage products. You can add, update and find products in addition to managing follow up sequences, tags and action sets.</p>
"""
["Discount"].create-an-order-discount():
<h4>Arguments</h4>
<b>privateKey:</b> string (required)
<p>Your Infusionsoft API key </p>
<b>name:</b> string (required)
<p>Description for commission </p>
<b>applyDiscountToCommission:</b> integer (required)
<p>Boolean of whether to apply the discount to the commission </p>
<b>percentOrAmt:</b> integer (required)
<p>A value of 1 is for percentage, whereas a value of 0 is for an amount </p>
<b>payType:</b> string (required)
<p>Value of either "gross" or "net" determines how to apply the discount </p>
argsrgs= {
"name" : "", ": "percentOrAmt": " payType":
}
ISServer.DiscountService(addOrderTotalDiscount, args)
["Discount"].retrieve-an-order-s-total-discount():
<h4>Arguments</h4>
<b>privateKey:</b> string (required)
<p>Your Infusionsoft API key </p>
<b>ID:</b> integer (required)
<p>The ID of the discount to retrieve </p>
args = {
"ID" : ""}
}
ISServer.DiscountService(getOrderTotalDiscount, args)
["Discount"].create-a-free-trial-on-a-subscription():
<h4>Arguments</h4>
<b>privateKey:</b> string (required)
<p>Your Infusionsoft API key </p>
<b>name:</b> string (required)
<p>The name of the free trial </p>
<b>description:</b> string (required)
<p>The description for free trial </p>
<b>freeTrialDays:</b> integer (required)
<p>The number of days free trial last </p>
<b>hidePrice:</b> integer (required)
<p>The option to show or hide price </p>
<b>subscriptionPlanID:</b> integer (required)
<p>The ID of the subscription to add the free trial to </p>
<h4>Returns</h4>
<p>Returns a boolean "true" if successful </p>
args = {
"name" : ""
"description" : ""
"freeTrialDays" : ""
"hidePrice" : ""
"subscriptionPlanID" : ""
}
ISServer.DiscountService(addFreeTrial, args)
["Discount"].retrieve-a-subscription-s-free-trial():
<h4>Arguments</h4>
<b>privateKey:</b> string (required)
<p>Your Infusionsoft API key </p>
<b>trialId:</b> integer (required)
<p>ID of the free trial to retrieve </p>
args = {
"trialId" : ""}
}
ISServer.DiscountService(getFreeTrial, args)
["Discount"].create-a-shipping-discount():
<h4>Arguments</h4>
<b>privateKey:</b> string (required)
<p>Your Infusionsoft API key </p>
<b>name:</b> string (required)
<p>Name of the discount </p>
<b>description:</b> string (required)
<p>Description of the shipping discount </p>
<b>applyDiscountToCommission:</b> integer (required)
<p>Integer value of 1 for true and 0 for false </p>
<b>percentOrAmt:</b> integer (required)
<p>Integer value of 1 for percent and 0 for amount </p>
<b>amt:</b> double (required)
<p>Amount of the discount </p>
args = {
"name" : ""
"description" : ""
"applyDiscountToCommission" : ""
"percentOrAmt" : ""
"amt" : ""
}
ISServer.DiscountService(addShippingTotalDiscount, args)
["Discount"].retrieve-a-shipping-discount():
<h4>Arguments</h4>
<b>privateKey:</b> string (required)
<p>Your Infusionsoft API key </p>
<b>shippingDiscountID:</b> integer (required)
<p>ID of the shipping discount to retrieve </p>
args = {
"shippingDiscountID" : ""}
}
ISServer.DiscountService(getShippingTotalDiscount, args)
["Discount"].create-a-product-discount():
<h4>Arguments</h4>
<b>privateKey:</b> string (required)
<p>Your Infusionsoft API key </p>
<b>name:</b> string (required)
<p>The name of the discount </p>
<b>description:</b> string (required)
<p>A description of the discount </p>
<b>applyDiscountToCommission:</b> integer (required)
<p>Boolean whether to apply the discount to any commission on the product </p>
<b>productID:</b> integer (required)
<p>The ID of the product to assign the discount to </p>
<b>percentOrAmt:</b> integer (required)
<p>Integer defining whether to handle the discount as a percent (1) or flat amount (0) </p>
<b>amt:</b> double (required)
<p>An integer amount of the discount </p>
args = {
"name" : ""
"description" : ""
"applyDiscountToCommission" : ""
"productID" : ""
"percentOrAmt" : ""
"amt" : ""
}
ISServer.DiscountService(addProductTotalDiscount, args)
["Discount"].retrieve-a-product-total-discount():
<h4>Arguments</h4>
<b>privateKey:</b> string (required)
<p>Your Infusionsoft API key </p>
<b>productDiscountID:</b> string (required)
<p>ID of the product discount </p>
args = {
"productDiscountID" : ""}
}
ISServer.DiscountService(getProductTotalDiscount, args)
["Discount"].create-a-category-discount():
<h4>Arguments</h4>
<b>privateKey:</b> string (required)
<p>Your Infusionsoft API key </p>
<b>name:</b> string (required)
<p>The category discount name </p>
<b>description:</b> string (required)
<p>The description of the category discount </p>
<b>applyDiscountToCommission:</b> integer (required)
<p>Boolean integer to determine whether or not a discount is applied to commission </p>
<b>amt:</b> integer (required)
<p>The amount of the discount </p>
args = {
"name" : ""
"description" : ""
"applyDiscountToCommission" : ""
"amt" : ""
}
ISServer.DiscountService(addCategoryDiscount, args)
["Discount"].retrieve-a-category-discount():
<h4>Arguments</h4>
<b>privateKey:</b> string (required)
<p>Your Infusionsoft API key </p>
<b>ID:</b> integer (required)
<p>The ID of the category discount to retrieve </p>
args = {
"ID" : ""}
}
ISServer.DiscountService(getCategoryDiscount, args)
["Discount"].retrieve-a-category-discount-s-category-assignments():
<h4>Arguments</h4>
<b>privateKey:</b> string (required)
<p>Your Infusionsoft API key </p>
<b>ID:</b> integer (required)
<p>ID of the category discount </p>
args = {
"ID" : ""}
}
ISServer.DiscountService(getCategoryAssignmentsForCategoryDiscount, args)
["Discount"].assign-a-product-to-a-category-discount():
<h4>Arguments</h4>
<b>privateKey:</b> string (required)
<p>Your Infusionsoft API key </p>
<b>ID:</b> integer (required)
<p>The ID of the category discount </p>
<b>productID:</b> integer (required)
<p>The ID of the product to assign the discount to </p>
args = {
"ID" : ""
"productID" : ""
}
ISServer.DiscountService(addCategoryAssignmentToCategoryDiscount, args)
class Email(object):
"""Email
<p>The Email service allows you to email your contacts as well as attaching emails sent elsewhere (this lets you send email from multiple services and still see all communications inside of Infusionsoft).</p>
"""
["Email"].opt-in-an-email-address():
<h4>Arguments</h4>
<b>privateKey:</b> string (required)
<p>Your Infusionsoft API key </p>
<b>email:</b> string (required)
<p>The email address to opt-in </p>
<b>optInReason:</b> string (required)
<p>Why/how this email was opted-in </p>
<h4>Returns</h4>
<p>Returns a boolean true upon successful opt-in.</p>
args = {
"email" : ""
"optInReason" : ""
}
ISServer.APIEmailService(optIn, args)
["Email"].opt-out-an-email-address():
<h4>Arguments</h4>
<b>privateKey:</b> string (required)
<p>Your Infusionsoft API key </p>
<b>email:</b> string (required)
<p>The email address to opt-out </p>
<b>optOutReason:</b> string (required)
<p>Reason the address is being opt-out </p>
args = {
"email" : ""
"optOutReason" : ""
}
ISServer.APIEmailService(optOut, args)
["Email"].retrieve-an-email-s-opt-in-status():
<h4>Arguments</h4>
<b>privateKey:</b> string (required)
<p>Your Infusionsoft API key </p>
<b>email:</b> string (required)
<p>The email address you wish to retrieve the status of </p>
<h4>Returns</h4>
<p>Returns an integer value of 0 for opt out/non-marketable/soft bounce/hard bounce, 1 for single opt-in, or 2 for double opt-in.</p>
args = {
"email" : ""}
}
ISServer.APIEmailService(getOptStatus, args)
["Email"].create-an-email-template():
<h4>Arguments</h4>
<b>privateKey:</b> string (required)
<p>Your Infusionsoft API key </p>
<b>templateName:</b> string (required)
<p>The name of the template. This will be displayed within the Infusionsoft template library. </p>