forked from pardot/api-docs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
apidescription.xml
360 lines (325 loc) · 17.2 KB
/
apidescription.xml
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
<?xml version="1.0" encoding="UTF-8"?>
<!-- Apigee WADL for the Pardot API --><!-- Please see http://developer.pardot.com for more information --><application xsi:schemaLocation="http://wadl.dev.java.net/2009/02 http://apigee.com/schemas/wadl-schema.xsd http://api.apigee.com/wadl/2010/07/ http://apigee.com/schemas/apigee-wadl-extensions.xsd" xmlns="http://wadl.dev.java.net/2009/02" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:apigee="http://api.apigee.com/wadl/2010/07/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<!-- Base defines the domain and base path of the endpoint -->
<resources base="https://pi.pardot.com/api/">
<!-- Authentication -->
<!-- Use this method to acquire an API key, which expires after 60 minutes. Your API and User keys need to be included as parameters in each API request. More information can be found at http://developer.pardot.com/kb/api-version-3/authentication -->
<resource path="login/version/3">
<method apigee:displayName="Login" id="login" name="POST">
<!-- Tags are used to organize the list of methods. Primary tag will list the default placement. -->
<apigee:tags>
<apigee:tag primary="true">Authentication</apigee:tag>
</apigee:tags>
<!-- Is authentication required for this method? -->
<apigee:authentication required="false"/>
<!-- Example element is used to specify the sample URL to display in the Console's request URL field. -->
<apigee:example url="/login/version/3?email={email}&password={password}&user_key={user_key}"/>
<!-- The content of the doc element is shown as a tooltip in the Console's method list. -->
<doc apigee:url="http://developer.pardot.com/kb/api-version-3/authentication" title="login">
Authenticate a connection to the API.
</doc>
</method>
</resource>
<!-- -->
<!-- OPPORTUNITIES -->
<!-- -->
<!-- Query Opportunities -->
<resource path="opportunity/version/3/do/query">
<method apigee:displayName="Query" id="opportunities_query" name="POST">
<apigee:tags>
<apigee:tag primary="true">Opportunities</apigee:tag>
</apigee:tags>
<apigee:authentication required="false"/>
<apigee:example url="/opportunity/version/3/do/query?user_key={user_key}&api_key={api_key}"/>
<doc apigee:url="http://developer.pardot.com/kb/api-version-3/opportunities/#querying-opportunities" title="opportunities_query">
Returns the opportunities matching the specified criteria parameters.
</doc>
</method>
</resource>
<!-- Create an Opportunity specified by email address -->
<resource path="opportunity/version/3/do/create">
<method apigee:displayName="Create by Email" id="opportunity_create_byemail" name="POST">
<apigee:tags>
<apigee:tag primary="true">Opportunities</apigee:tag>
</apigee:tags>
<apigee:authentication required="false"/>
<apigee:example url="/opportunity/version/3/do/create/prospect_email/{prospect_email}?user_key={user_key}&api_key={api_key}&name={name}&value={value}&probability={probability}"/>
<doc apigee:url="http://developer.pardot.com/kb/api-version-3/opportunities/#supported-operations_1" title="opportunity_create_byemail">
Creates a new opportunity using a prospect email address.
</doc>
</method>
</resource>
<!-- Create an Opportunity specified by ID -->
<resource path="opportunity/version/3/do/create">
<method apigee:displayName="Create by ID" id="opportunity_create_byid" name="POST">
<apigee:tags>
<apigee:tag primary="true">Opportunities</apigee:tag>
</apigee:tags>
<apigee:authentication required="false"/>
<apigee:example url="/opportunity/version/3/do/create/prospect_id/{prospect_id}?user_key={user_key}&api_key={api_key}&name={name}&value={value}&probability={probability}"/>
<doc apigee:url="http://developer.pardot.com/kb/api-version-3/opportunities/#supported-operations_1" title="opportunity_create_byid">
Creates a new opportunity using a prospect ID.
</doc>
</method>
</resource>
<!-- Read an Opportunity -->
<resource path="opportunity/version/3/do/query">
<method apigee:displayName="Read" id="opportunity_read" name="POST">
<apigee:tags>
<apigee:tag primary="true">Opportunities</apigee:tag>
</apigee:tags>
<apigee:authentication required="false"/>
<apigee:example url="/opportunity/version/3/do/read/{id}?id={id}&user_key={user_key}&api_key={api_key}"/>
<doc apigee:url="http://developer.pardot.com/kb/api-version-3/opportunities/#supported-operations_1" title="opportunity_read">
Returns the data for the opportunity specified by ID.
</doc>
</method>
</resource>
<!-- -->
<!-- PROSPECTS -->
<!-- -->
<!-- Query Prospects -->
<resource path="prospect/version/3/do/query">
<method apigee:displayName="Query" id="prospects_query" name="POST">
<apigee:tags>
<apigee:tag primary="true">Prospects</apigee:tag>
</apigee:tags>
<apigee:authentication required="false"/>
<apigee:example url="/prospect/version/3/do/query?user_key={user_key}&api_key={api_key}"/>
<doc apigee:url="http://developer.pardot.com/kb/api-version-3/prospects/#querying-prospects" title="prospects_query">
Returns the prospects matching the specified criteria parameters.
</doc>
</method>
</resource>
<!-- Assign a Prospect specified by email address -->
<resource path="prospect/version/3/do/assign">
<method apigee:displayName="Assign by Email" id="prospect_assign_byemail" name="POST">
<apigee:tags>
<apigee:tag primary="true">Prospects</apigee:tag>
</apigee:tags>
<apigee:authentication required="false"/>
<apigee:example url="/prospect/version/3/do/assign/email/{email}?user_key={user_key}&api_key={api_key}&user_email={user_email}"/>
<doc apigee:url="http://developer.pardot.com/kb/api-version-3/prospects/#supported-operations_1" title="prospect_assign_byemail">
Assigns or reassigns the prospect specified by email address to a specified Pardot user or group.
</doc>
</method>
</resource>
<!-- Assign a Prospect specified by ID -->
<resource path="prospect/version/3/do/assign">
<method apigee:displayName="Assign by ID" id="prospect_assign_byid" name="POST">
<apigee:tags>
<apigee:tag primary="true">Prospects</apigee:tag>
</apigee:tags>
<apigee:authentication required="false"/>
<apigee:example url="/prospect/version/3/do/assign/id/{id}?user_key={user_key}&api_key={api_key}&user_email={user_email}"/>
<doc apigee:url="http://developer.pardot.com/kb/api-version-3/prospects/#supported-operations_1" title="prospect_assign_byid">
Assigns or reassigns the prospect specified by ID to a specified Pardot user or group.
</doc>
</method>
</resource>
<!-- Create a Prospect specified by email address -->
<resource path="prospect/version/3/do/create">
<method apigee:displayName="Create" id="prospect_create" name="POST">
<apigee:tags>
<apigee:tag primary="true">Prospects</apigee:tag>
</apigee:tags>
<apigee:authentication required="false"/>
<apigee:example url="/prospect/version/3/do/create/email/{email}?user_key={user_key}&api_key={api_key}&email={email}"/>
<doc apigee:url="http://developer.pardot.com/kb/api-version-3/prospects/#supported-operations_1" title="prospect_create">
Creates a new prospect using the specified data.
</doc>
</method>
</resource>
<!-- Read a Prospect specified by ID -->
<resource path="prospect/version/3/do/read">
<method apigee:displayName="Read by ID" id="prospect_read_byid" name="POST">
<apigee:tags>
<apigee:tag primary="true">Prospects</apigee:tag>
</apigee:tags>
<apigee:authentication required="false"/>
<apigee:example url="/prospect/version/3/do/read/id/{id}?user_key={user_key}&api_key={api_key}"/>
<doc apigee:url="http://developer.pardot.com/kb/api-version-3/prospects/#supported-operations_1" title="prospect_read_byid">
Returns the data for the prospect specified by ID.
</doc>
</method>
</resource>
<!-- Read a Prospect specified by email address -->
<resource path="prospect/version/3/do/read">
<method apigee:displayName="Read by Email" id="prospect_read_byemail" name="POST">
<apigee:tags>
<apigee:tag primary="true">Prospects</apigee:tag>
</apigee:tags>
<apigee:authentication required="false"/>
<apigee:example url="/prospect/version/3/do/read/email/{email}?user_key={user_key}&api_key={api_key}"/>
<doc apigee:url="http://developer.pardot.com/kb/api-version-3/prospects/#supported-operations_1" title="prospect_read_byemail">
Returns the data for the prospect specified by email address.
</doc>
</method>
</resource>
<!-- Update a Prospect specified by ID -->
<resource path="prospect/version/3/do/update">
<method apigee:displayName="Update by ID" id="prospect_update_byid" name="POST">
<apigee:tags>
<apigee:tag primary="true">Prospects</apigee:tag>
</apigee:tags>
<apigee:authentication required="false"/>
<apigee:example url="/prospect/version/3/do/update/id/{id}?user_key={user_key}&api_key={api_key}"/>
<doc apigee:url="http://developer.pardot.com/kb/api-version-3/prospects/#supported-operations_1" title="prospect_update_byid">
Updates the provided data for a prospect specified by ID.
</doc>
</method>
</resource>
<!-- Update a Prospect specified by email address -->
<resource path="prospect/version/3/do/update">
<method apigee:displayName="Update by Email" id="prospect_update_byemail" name="POST">
<apigee:tags>
<apigee:tag primary="true">Prospects</apigee:tag>
</apigee:tags>
<apigee:authentication required="false"/>
<apigee:example url="/prospect/version/3/do/update/email/{email}?user_key={user_key}&api_key={api_key}"/>
<doc apigee:url="http://developer.pardot.com/kb/api-version-3/prospects/#supported-operations_1" title="prospect_update_byemail">
Updates the provided data for a prospect specified by email address.
</doc>
</method>
</resource>
<!-- Update a Prospect specified by ID, Create if nonexistent -->
<resource path="prospect/version/3/do/upsert">
<method apigee:displayName="Update/Create by ID" id="prospect_upsert_byid" name="POST">
<apigee:tags>
<apigee:tag primary="true">Prospects</apigee:tag>
</apigee:tags>
<apigee:authentication required="false"/>
<apigee:example url="/prospect/version/3/do/upsert/id/{id}?user_key={user_key}&api_key={api_key}"/>
<doc apigee:url="http://developer.pardot.com/kb/api-version-3/prospects/#supported-operations_1" title="prospect_upsert_byid">
Updates the provided data for a prospect specified by ID, crates a new prospect if one does not exist.
</doc>
</method>
</resource>
<!-- Update a Prospect specified by email address, Create if nonexistent -->
<resource path="prospect/version/3/do/upsert">
<method apigee:displayName="Update/Create by Email" id="prospect_upsert_byemail" name="POST">
<apigee:tags>
<apigee:tag primary="true">Prospects</apigee:tag>
</apigee:tags>
<apigee:authentication required="false"/>
<apigee:example url="/prospect/version/3/do/upsert/email/{email}?user_key={user_key}&api_key={api_key}"/>
<doc apigee:url="http://developer.pardot.com/kb/api-version-3/prospects/#supported-operations_1" title="prospect_upsert_byemail">
Updates the provided data for a prospect specified by email address, creates a new prospect if one does not exist.
</doc>
</method>
</resource>
<!-- -->
<!-- USERS -->
<!-- -->
<!-- Query Users -->
<resource path="users/version/3/do/query">
<method apigee:displayName="Query" id="users_query" name="POST">
<apigee:tags>
<apigee:tag primary="true">Users</apigee:tag>
</apigee:tags>
<apigee:authentication required="false"/>
<apigee:example url="/user/version/3/do/query?user_key={user_key}&api_key={api_key}"/>
<doc apigee:url="http://developer.pardot.com/kb/api-version-3/users/#querying-users" title="users_query">
Returns the users matching the specified criteria parameters.
</doc>
</method>
</resource>
<!-- Read a User specified by ID -->
<resource path="user/version/3/do/read">
<method apigee:displayName="Read by ID" id="user_read_byid" name="POST">
<apigee:tags>
<apigee:tag primary="true">Users</apigee:tag>
</apigee:tags>
<apigee:authentication required="false"/>
<apigee:example url="/user/version/3/do/read/id/{id}?user_key={user_key}&api_key={api_key}"/>
<doc apigee:url="http://developer.pardot.com/kb/api-version-3/users/#supported-operations_1" title="user_read_byid">
Returns the data for the user specified by ID.
</doc>
</method>
</resource>
<!-- Read a User specified by email address -->
<resource path="user/version/3/do/read">
<method apigee:displayName="Read by Email" id="user_read_byemail" name="POST">
<apigee:tags>
<apigee:tag primary="true">Users</apigee:tag>
</apigee:tags>
<apigee:authentication required="false"/>
<apigee:example url="/user/version/3/do/read/email/{email}?user_key={user_key}&api_key={api_key}"/>
<doc apigee:url="http://developer.pardot.com/kb/api-version-3/users/#supported-operations_1" title="user_read_byemail">
Returns the data for the user specified by email address.
</doc>
</method>
</resource>
<!-- -->
<!-- VISITS -->
<!-- -->
<!-- Query Visits -->
<resource path="visit/version/3/do/query">
<method apigee:displayName="Query" id="visits_query" name="POST">
<apigee:tags>
<apigee:tag primary="true">Visits</apigee:tag>
</apigee:tags>
<apigee:authentication required="false"/>
<apigee:example url="/visit/version/3/do/query?user_key={user_key}&api_key={api_key}"/>
<doc apigee:url="http://developer.pardot.com/kb/api-version-3/visits/#querying-visits" title="visits_query">
Returns the visits matching the specified criteria parameters.
</doc>
</method>
</resource>
<!-- Read a Visit specified by ID -->
<resource path="visit/version/3/do/read">
<method apigee:displayName="Read by ID" id="visit_read" name="POST">
<apigee:tags>
<apigee:tag primary="true">Visits</apigee:tag>
</apigee:tags>
<apigee:authentication required="false"/>
<apigee:example url="/visit/version/3/do/read/id/{id}?user_key={user_key}&api_key={api_key}"/>
<doc apigee:url="http://developer.pardot.com/kb/api-version-3/visits/#supported-operations_1" title="visit_read">
Returns the data for the visit specified by ID.
</doc>
</method>
</resource>
<!-- -->
<!-- VISITORS -->
<!-- -->
<!-- Query Visitors -->
<resource path="visitor/version/3/do/query">
<method apigee:displayName="Query" id="visitors_query" name="POST">
<apigee:tags>
<apigee:tag primary="true">Visitors</apigee:tag>
</apigee:tags>
<apigee:authentication required="false"/>
<apigee:example url="/visitor/version/3/do/query?user_key={user_key}&api_key={api_key}"/>
<doc apigee:url="http://developer.pardot.com/kb/api-version-3/visitors/#querying-visitors" title="visitors_query">
Returns the visitors matching the specified criteria parameters.
</doc>
</method>
</resource>
<!-- Read a Visitor specified by ID -->
<resource path="visit/version/3/do/read">
<method apigee:displayName="Read by ID" id="visitor_read" name="POST">
<apigee:tags>
<apigee:tag primary="true">Visitors</apigee:tag>
</apigee:tags>
<apigee:authentication required="false"/>
<apigee:example url="/visitor/version/3/do/read/id/{id}?user_key={user_key}&api_key={api_key}"/>
<doc apigee:url="http://developer.pardot.com/kb/api-version-3/visitors/#supported-operations" title="visitor_read">
Returns the data for the visitor specified by ID.
</doc>
</method>
</resource>
<!-- Assign a Visitor specified by ID -->
<resource path="visitor/version/3/do/assign">
<method apigee:displayName="Assign by ID" id="visitor_assign_byid" name="POST">
<apigee:tags>
<apigee:tag primary="true">Visitors</apigee:tag>
</apigee:tags>
<apigee:authentication required="false"/>
<apigee:example url="/visitor/version/3/do/assign/id/{id}?user_key={user_key}&api_key={api_key}&user_email={user_email}"/>
<doc apigee:url="http://developer.pardot.com/kb/api-version-3/visitors/#supported-operations" title="prospect_assign_byid">
Assigns or reassigns the visitor specified by ID to a specified Pardot user or group.
</doc>
</method>
</resource>
</resources>
</application>