kit-rb 0.4.0 → 0.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +38 -1
- data/README.md +79 -1
- data/Rakefile +9 -0
- data/lib/kit/configuration.rb +8 -2
- data/lib/kit/connection.rb +25 -23
- data/lib/kit/instrumentation.rb +136 -0
- data/lib/kit/resources/subscribers.rb +1 -4
- data/lib/kit/resources/tags.rb +5 -15
- data/lib/kit/tag_names.rb +29 -0
- data/lib/kit/testing/factories.rb +124 -0
- data/lib/kit/testing/fixtures.json +2947 -0
- data/lib/kit/testing/fixtures.rb +96 -0
- data/lib/kit/testing/operations.rb +132 -0
- data/lib/kit/testing/stubs.rb +145 -0
- data/lib/kit/testing.rb +185 -0
- data/lib/kit/version.rb +1 -1
- data/lib/kit-rb.rb +2 -0
- data/sig/kit-rb.rbs +125 -2
- metadata +9 -1
|
@@ -0,0 +1,2947 @@
|
|
|
1
|
+
{
|
|
2
|
+
"account_get": {
|
|
3
|
+
"verb": "get",
|
|
4
|
+
"path": "/v4/account",
|
|
5
|
+
"key": "account",
|
|
6
|
+
"kind": "object",
|
|
7
|
+
"type": "account",
|
|
8
|
+
"responses": {
|
|
9
|
+
"200": {
|
|
10
|
+
"user": {
|
|
11
|
+
"email": "test@kit.dev",
|
|
12
|
+
"id": 29
|
|
13
|
+
},
|
|
14
|
+
"account": {
|
|
15
|
+
"id": 29,
|
|
16
|
+
"name": "Kit Greetings",
|
|
17
|
+
"plan_type": "creator",
|
|
18
|
+
"primary_email_address": "test@kit.dev",
|
|
19
|
+
"created_at": "2023-02-17T11:43:55Z",
|
|
20
|
+
"timezone": {
|
|
21
|
+
"name": "America/New_York",
|
|
22
|
+
"friendly_name": "Eastern Time (US & Canada)",
|
|
23
|
+
"utc_offset": "-05:00"
|
|
24
|
+
},
|
|
25
|
+
"sending_addresses": [
|
|
26
|
+
{
|
|
27
|
+
"email_address": "joe29@ck.lol",
|
|
28
|
+
"from_name": "Joe",
|
|
29
|
+
"status": "pending",
|
|
30
|
+
"is_default": true,
|
|
31
|
+
"is_verified": false,
|
|
32
|
+
"is_dmarc_configured": false
|
|
33
|
+
}
|
|
34
|
+
],
|
|
35
|
+
"plan": {
|
|
36
|
+
"plan_type": "creator",
|
|
37
|
+
"interval": "month",
|
|
38
|
+
"subscriber_limit": 1000,
|
|
39
|
+
"on_trial": false,
|
|
40
|
+
"trial_lapse_date": null,
|
|
41
|
+
"renews_at": "2023-03-17T11:43:55Z",
|
|
42
|
+
"cancels_at": null
|
|
43
|
+
}
|
|
44
|
+
}
|
|
45
|
+
}
|
|
46
|
+
}
|
|
47
|
+
},
|
|
48
|
+
"account_colors": {
|
|
49
|
+
"verb": "get",
|
|
50
|
+
"path": "/v4/account/colors",
|
|
51
|
+
"key": null,
|
|
52
|
+
"kind": "raw",
|
|
53
|
+
"type": null,
|
|
54
|
+
"responses": {
|
|
55
|
+
"200": {
|
|
56
|
+
"colors": [
|
|
57
|
+
"#008000",
|
|
58
|
+
"#FF0000"
|
|
59
|
+
]
|
|
60
|
+
}
|
|
61
|
+
}
|
|
62
|
+
},
|
|
63
|
+
"account_update_colors": {
|
|
64
|
+
"verb": "put",
|
|
65
|
+
"path": "/v4/account/colors",
|
|
66
|
+
"key": null,
|
|
67
|
+
"kind": "raw",
|
|
68
|
+
"type": null,
|
|
69
|
+
"responses": {
|
|
70
|
+
"200": {
|
|
71
|
+
"colors": [
|
|
72
|
+
"#000000",
|
|
73
|
+
"#ffffff"
|
|
74
|
+
]
|
|
75
|
+
}
|
|
76
|
+
}
|
|
77
|
+
},
|
|
78
|
+
"account_creator_profile": {
|
|
79
|
+
"verb": "get",
|
|
80
|
+
"path": "/v4/account/creator_profile",
|
|
81
|
+
"key": "profile",
|
|
82
|
+
"kind": "object",
|
|
83
|
+
"type": "creator_profile",
|
|
84
|
+
"responses": {
|
|
85
|
+
"200": {
|
|
86
|
+
"profile": {
|
|
87
|
+
"name": "A Creator's Journey",
|
|
88
|
+
"byline": "A Creator",
|
|
89
|
+
"bio": "Follow my Journey as a Creator",
|
|
90
|
+
"image_url": "https://convertkit.dev/image.jpg?fit=crop&h=320&w=320",
|
|
91
|
+
"profile_url": "https://kit-greetings.kit.com/profile"
|
|
92
|
+
}
|
|
93
|
+
}
|
|
94
|
+
}
|
|
95
|
+
},
|
|
96
|
+
"account_email_stats": {
|
|
97
|
+
"verb": "get",
|
|
98
|
+
"path": "/v4/account/email_stats",
|
|
99
|
+
"key": "stats",
|
|
100
|
+
"kind": "object",
|
|
101
|
+
"type": "email_stats",
|
|
102
|
+
"responses": {
|
|
103
|
+
"200": {
|
|
104
|
+
"stats": {
|
|
105
|
+
"sent": 6,
|
|
106
|
+
"clicked": 3,
|
|
107
|
+
"opened": 6,
|
|
108
|
+
"email_stats_mode": "last_90",
|
|
109
|
+
"open_tracking_enabled": true,
|
|
110
|
+
"click_tracking_enabled": true,
|
|
111
|
+
"starting": "2022-11-19T11:43:55Z",
|
|
112
|
+
"ending": "2023-02-17T11:43:55Z",
|
|
113
|
+
"open_rate": 100.0,
|
|
114
|
+
"click_rate": 50.0,
|
|
115
|
+
"unsubscribe_rate": 16.67,
|
|
116
|
+
"bounce_rate": 16.67
|
|
117
|
+
}
|
|
118
|
+
}
|
|
119
|
+
}
|
|
120
|
+
},
|
|
121
|
+
"account_growth_stats": {
|
|
122
|
+
"verb": "get",
|
|
123
|
+
"path": "/v4/account/growth_stats",
|
|
124
|
+
"key": "stats",
|
|
125
|
+
"kind": "object",
|
|
126
|
+
"type": "growth_stats",
|
|
127
|
+
"responses": {
|
|
128
|
+
"200": {
|
|
129
|
+
"stats": {
|
|
130
|
+
"cancellations": 0,
|
|
131
|
+
"net_new_subscribers": 3,
|
|
132
|
+
"new_subscribers": 3,
|
|
133
|
+
"subscribers": 3,
|
|
134
|
+
"starting": "2023-02-10T00:00:00-05:00",
|
|
135
|
+
"ending": "2023-02-24T23:59:59-05:00"
|
|
136
|
+
}
|
|
137
|
+
}
|
|
138
|
+
}
|
|
139
|
+
},
|
|
140
|
+
"subscribers_list": {
|
|
141
|
+
"verb": "get",
|
|
142
|
+
"path": "/v4/subscribers",
|
|
143
|
+
"key": "subscribers",
|
|
144
|
+
"kind": "list",
|
|
145
|
+
"type": "subscriber",
|
|
146
|
+
"responses": {
|
|
147
|
+
"200": {
|
|
148
|
+
"subscribers": [
|
|
149
|
+
{
|
|
150
|
+
"id": 204,
|
|
151
|
+
"state": "active",
|
|
152
|
+
"first_name": "Alice",
|
|
153
|
+
"email_address": "alice@convertkit.dev",
|
|
154
|
+
"created_at": "2023-01-27T11:43:55Z",
|
|
155
|
+
"fields": {
|
|
156
|
+
"category": "One"
|
|
157
|
+
},
|
|
158
|
+
"attribution": {
|
|
159
|
+
"referrer": "https://t.co/abc123",
|
|
160
|
+
"utm_source": "twitter",
|
|
161
|
+
"utm_medium": "cpc",
|
|
162
|
+
"utm_campaign": "spring_launch",
|
|
163
|
+
"utm_term": "newsletter+for+creators",
|
|
164
|
+
"utm_content": "hero_cta",
|
|
165
|
+
"source_type": "form_subscription",
|
|
166
|
+
"source_name": "Welcome Form",
|
|
167
|
+
"source_mechanism": "landing_page",
|
|
168
|
+
"source_mechanism_id": null
|
|
169
|
+
},
|
|
170
|
+
"tags": [
|
|
171
|
+
{
|
|
172
|
+
"id": 1,
|
|
173
|
+
"name": "VIP"
|
|
174
|
+
}
|
|
175
|
+
],
|
|
176
|
+
"location": {
|
|
177
|
+
"city": "Portland",
|
|
178
|
+
"state": "OR",
|
|
179
|
+
"country": "US",
|
|
180
|
+
"latitude": 45.5,
|
|
181
|
+
"longitude": -122.6,
|
|
182
|
+
"timezone": "America/Los_Angeles"
|
|
183
|
+
}
|
|
184
|
+
},
|
|
185
|
+
{
|
|
186
|
+
"id": 205,
|
|
187
|
+
"state": "active",
|
|
188
|
+
"first_name": "Benito",
|
|
189
|
+
"email_address": "benito@convertkit.dev",
|
|
190
|
+
"created_at": "2023-02-03T11:43:55Z",
|
|
191
|
+
"fields": {},
|
|
192
|
+
"attribution": {
|
|
193
|
+
"referrer": "https://creator.kit.com/jane-smith",
|
|
194
|
+
"utm_source": "kit",
|
|
195
|
+
"utm_medium": "referral",
|
|
196
|
+
"utm_campaign": null,
|
|
197
|
+
"utm_term": null,
|
|
198
|
+
"utm_content": null,
|
|
199
|
+
"source_type": "form_subscription",
|
|
200
|
+
"source_name": "Jane Smith's Recommendations",
|
|
201
|
+
"source_mechanism": "recommendations",
|
|
202
|
+
"source_mechanism_id": null
|
|
203
|
+
},
|
|
204
|
+
"tags": [
|
|
205
|
+
{
|
|
206
|
+
"id": 2,
|
|
207
|
+
"name": "Newsletter"
|
|
208
|
+
}
|
|
209
|
+
],
|
|
210
|
+
"location": {
|
|
211
|
+
"city": "Austin",
|
|
212
|
+
"state": "TX",
|
|
213
|
+
"country": "US",
|
|
214
|
+
"latitude": 30.27,
|
|
215
|
+
"longitude": -97.74,
|
|
216
|
+
"timezone": "America/Chicago"
|
|
217
|
+
}
|
|
218
|
+
},
|
|
219
|
+
{
|
|
220
|
+
"id": 206,
|
|
221
|
+
"state": "active",
|
|
222
|
+
"first_name": "Camille",
|
|
223
|
+
"email_address": "camille@convertkit.dev",
|
|
224
|
+
"created_at": "2023-02-10T11:43:55Z",
|
|
225
|
+
"fields": {},
|
|
226
|
+
"attribution": {
|
|
227
|
+
"referrer": null,
|
|
228
|
+
"utm_source": null,
|
|
229
|
+
"utm_medium": null,
|
|
230
|
+
"utm_campaign": null,
|
|
231
|
+
"utm_term": null,
|
|
232
|
+
"utm_content": null,
|
|
233
|
+
"source_type": "api_subscription",
|
|
234
|
+
"source_name": "Partner Integration",
|
|
235
|
+
"source_mechanism": "api",
|
|
236
|
+
"source_mechanism_id": 12345
|
|
237
|
+
},
|
|
238
|
+
"tags": [],
|
|
239
|
+
"location": null
|
|
240
|
+
},
|
|
241
|
+
{
|
|
242
|
+
"id": 207,
|
|
243
|
+
"state": "active",
|
|
244
|
+
"first_name": "Elliot",
|
|
245
|
+
"email_address": "elliot@convertkit.dev",
|
|
246
|
+
"created_at": "2023-02-13T11:43:55Z",
|
|
247
|
+
"fields": {},
|
|
248
|
+
"attribution": {
|
|
249
|
+
"referrer": null,
|
|
250
|
+
"utm_source": null,
|
|
251
|
+
"utm_medium": null,
|
|
252
|
+
"utm_campaign": null,
|
|
253
|
+
"utm_term": null,
|
|
254
|
+
"utm_content": null,
|
|
255
|
+
"source_type": null,
|
|
256
|
+
"source_name": null,
|
|
257
|
+
"source_mechanism": null,
|
|
258
|
+
"source_mechanism_id": null
|
|
259
|
+
},
|
|
260
|
+
"tags": [
|
|
261
|
+
{
|
|
262
|
+
"id": 3,
|
|
263
|
+
"name": "Imported"
|
|
264
|
+
}
|
|
265
|
+
],
|
|
266
|
+
"location": {
|
|
267
|
+
"city": null,
|
|
268
|
+
"state": null,
|
|
269
|
+
"country": null,
|
|
270
|
+
"latitude": null,
|
|
271
|
+
"longitude": null,
|
|
272
|
+
"timezone": null
|
|
273
|
+
}
|
|
274
|
+
}
|
|
275
|
+
],
|
|
276
|
+
"pagination": {
|
|
277
|
+
"has_previous_page": false,
|
|
278
|
+
"has_next_page": false,
|
|
279
|
+
"start_cursor": "MjAyMy0wMS0yNyAxMTo0Mzo1NSBVVEM=",
|
|
280
|
+
"end_cursor": "MjAyMy0wMi0xMyAxMTo0Mzo1NSBVVEM=",
|
|
281
|
+
"per_page": 500
|
|
282
|
+
}
|
|
283
|
+
}
|
|
284
|
+
}
|
|
285
|
+
},
|
|
286
|
+
"subscribers_create": {
|
|
287
|
+
"verb": "post",
|
|
288
|
+
"path": "/v4/subscribers",
|
|
289
|
+
"key": "subscriber",
|
|
290
|
+
"kind": "object",
|
|
291
|
+
"type": "subscriber",
|
|
292
|
+
"responses": {
|
|
293
|
+
"200": {
|
|
294
|
+
"subscriber": {
|
|
295
|
+
"id": 357,
|
|
296
|
+
"first_name": "Alice",
|
|
297
|
+
"email_address": "alice@convertkit.dev",
|
|
298
|
+
"state": "inactive",
|
|
299
|
+
"created_at": "2023-02-17T11:43:55Z",
|
|
300
|
+
"fields": {}
|
|
301
|
+
}
|
|
302
|
+
},
|
|
303
|
+
"201": {
|
|
304
|
+
"subscriber": {
|
|
305
|
+
"id": 353,
|
|
306
|
+
"first_name": "Alice",
|
|
307
|
+
"email_address": "alice@convertkit.dev",
|
|
308
|
+
"state": "active",
|
|
309
|
+
"created_at": "2023-02-17T11:43:55Z",
|
|
310
|
+
"fields": {
|
|
311
|
+
"birthday": "Feb 17",
|
|
312
|
+
"last_name": "Lamarr",
|
|
313
|
+
"source": "landing page"
|
|
314
|
+
}
|
|
315
|
+
}
|
|
316
|
+
},
|
|
317
|
+
"202": {
|
|
318
|
+
"subscriber": {
|
|
319
|
+
"id": 355,
|
|
320
|
+
"first_name": "Alice",
|
|
321
|
+
"email_address": "alice@convertkit.dev",
|
|
322
|
+
"state": "active",
|
|
323
|
+
"created_at": "2023-02-17T11:43:55Z",
|
|
324
|
+
"fields": {
|
|
325
|
+
"company": null,
|
|
326
|
+
"coupon": null,
|
|
327
|
+
"enrolled_in_coaching": null,
|
|
328
|
+
"how_did_you_hear_about_us": null,
|
|
329
|
+
"interests": null,
|
|
330
|
+
"lead_score": null,
|
|
331
|
+
"phone_number": null,
|
|
332
|
+
"postal_code": null,
|
|
333
|
+
"role": null,
|
|
334
|
+
"social_media": null,
|
|
335
|
+
"website": null
|
|
336
|
+
}
|
|
337
|
+
}
|
|
338
|
+
}
|
|
339
|
+
}
|
|
340
|
+
},
|
|
341
|
+
"subscribers_filter": {
|
|
342
|
+
"verb": "post",
|
|
343
|
+
"path": "/v4/subscribers/filter",
|
|
344
|
+
"key": "subscribers",
|
|
345
|
+
"kind": "list",
|
|
346
|
+
"type": "subscriber",
|
|
347
|
+
"responses": {
|
|
348
|
+
"200": {
|
|
349
|
+
"subscribers": [
|
|
350
|
+
{
|
|
351
|
+
"id": "456",
|
|
352
|
+
"first_name": "Jane",
|
|
353
|
+
"email_address": "jane@example.com",
|
|
354
|
+
"created_at": "2024-12-01T15:45:00Z",
|
|
355
|
+
"tag_names": [
|
|
356
|
+
"newsletter",
|
|
357
|
+
"engaged"
|
|
358
|
+
],
|
|
359
|
+
"tag_ids": [
|
|
360
|
+
"123",
|
|
361
|
+
"456"
|
|
362
|
+
]
|
|
363
|
+
},
|
|
364
|
+
{
|
|
365
|
+
"id": "789",
|
|
366
|
+
"first_name": null,
|
|
367
|
+
"email_address": "anonymous@example.com",
|
|
368
|
+
"created_at": "2024-11-15T10:00:00Z",
|
|
369
|
+
"tag_names": [],
|
|
370
|
+
"tag_ids": []
|
|
371
|
+
}
|
|
372
|
+
],
|
|
373
|
+
"pagination": {
|
|
374
|
+
"has_previous_page": false,
|
|
375
|
+
"has_next_page": true,
|
|
376
|
+
"start_cursor": "WzQ1Nl0=",
|
|
377
|
+
"end_cursor": "Wzc4OV0=",
|
|
378
|
+
"per_page": 10,
|
|
379
|
+
"total_count": 42
|
|
380
|
+
}
|
|
381
|
+
}
|
|
382
|
+
}
|
|
383
|
+
},
|
|
384
|
+
"subscribers_get": {
|
|
385
|
+
"verb": "get",
|
|
386
|
+
"path": "/v4/subscribers/{id}",
|
|
387
|
+
"key": "subscriber",
|
|
388
|
+
"kind": "object",
|
|
389
|
+
"type": "subscriber",
|
|
390
|
+
"responses": {
|
|
391
|
+
"200": {
|
|
392
|
+
"subscriber": {
|
|
393
|
+
"id": 339,
|
|
394
|
+
"first_name": "Alice",
|
|
395
|
+
"email_address": "alice@convertkit.dev",
|
|
396
|
+
"state": "active",
|
|
397
|
+
"created_at": "2023-02-17T11:43:55Z",
|
|
398
|
+
"fields": {
|
|
399
|
+
"category": "One"
|
|
400
|
+
},
|
|
401
|
+
"canceled_at": null,
|
|
402
|
+
"location": {
|
|
403
|
+
"city": "Williamstown",
|
|
404
|
+
"state": "Massachusetts",
|
|
405
|
+
"country": "US",
|
|
406
|
+
"latitude": 9.99,
|
|
407
|
+
"longitude": 9.99,
|
|
408
|
+
"timezone": "US/EST"
|
|
409
|
+
}
|
|
410
|
+
}
|
|
411
|
+
}
|
|
412
|
+
}
|
|
413
|
+
},
|
|
414
|
+
"subscribers_update": {
|
|
415
|
+
"verb": "put",
|
|
416
|
+
"path": "/v4/subscribers/{id}",
|
|
417
|
+
"key": "subscriber",
|
|
418
|
+
"kind": "object",
|
|
419
|
+
"type": "subscriber",
|
|
420
|
+
"responses": {
|
|
421
|
+
"200": {
|
|
422
|
+
"subscriber": {
|
|
423
|
+
"id": 382,
|
|
424
|
+
"first_name": "Alice",
|
|
425
|
+
"email_address": "alice@convertkit.dev",
|
|
426
|
+
"state": "active",
|
|
427
|
+
"created_at": "2023-02-17T11:43:55Z",
|
|
428
|
+
"fields": {
|
|
429
|
+
"birthday": "Feb 17",
|
|
430
|
+
"last_name": "Lamarr",
|
|
431
|
+
"source": "landing page"
|
|
432
|
+
}
|
|
433
|
+
}
|
|
434
|
+
},
|
|
435
|
+
"202": {
|
|
436
|
+
"subscriber": {
|
|
437
|
+
"id": 384,
|
|
438
|
+
"first_name": "Alice",
|
|
439
|
+
"email_address": "alice@convertkit.dev",
|
|
440
|
+
"state": "active",
|
|
441
|
+
"created_at": "2023-02-17T11:43:55Z",
|
|
442
|
+
"fields": {
|
|
443
|
+
"birthday": null,
|
|
444
|
+
"company": null,
|
|
445
|
+
"coupon": null,
|
|
446
|
+
"how_did_you_hear_about_us": null,
|
|
447
|
+
"interests": null,
|
|
448
|
+
"last_name": null,
|
|
449
|
+
"postal_code": null,
|
|
450
|
+
"role": null,
|
|
451
|
+
"social_media": null,
|
|
452
|
+
"source": null,
|
|
453
|
+
"website": null
|
|
454
|
+
}
|
|
455
|
+
}
|
|
456
|
+
}
|
|
457
|
+
}
|
|
458
|
+
},
|
|
459
|
+
"subscribers_unsubscribe": {
|
|
460
|
+
"verb": "post",
|
|
461
|
+
"path": "/v4/subscribers/{id}/unsubscribe",
|
|
462
|
+
"key": null,
|
|
463
|
+
"kind": "none",
|
|
464
|
+
"type": null,
|
|
465
|
+
"responses": {
|
|
466
|
+
"204": null
|
|
467
|
+
}
|
|
468
|
+
},
|
|
469
|
+
"subscribers_tags": {
|
|
470
|
+
"verb": "get",
|
|
471
|
+
"path": "/v4/subscribers/{subscriber_id}/tags",
|
|
472
|
+
"key": "tags",
|
|
473
|
+
"kind": "list",
|
|
474
|
+
"type": "tag",
|
|
475
|
+
"responses": {
|
|
476
|
+
"200": {
|
|
477
|
+
"tags": [
|
|
478
|
+
{
|
|
479
|
+
"id": 140,
|
|
480
|
+
"name": "Tag B",
|
|
481
|
+
"tagged_at": "2023-02-17T10:43:55Z"
|
|
482
|
+
},
|
|
483
|
+
{
|
|
484
|
+
"id": 141,
|
|
485
|
+
"name": "Tag A",
|
|
486
|
+
"tagged_at": "2023-02-17T10:43:55Z"
|
|
487
|
+
}
|
|
488
|
+
],
|
|
489
|
+
"pagination": {
|
|
490
|
+
"has_previous_page": false,
|
|
491
|
+
"has_next_page": false,
|
|
492
|
+
"start_cursor": "WzEyXQ==",
|
|
493
|
+
"end_cursor": "WzExXQ==",
|
|
494
|
+
"per_page": 500
|
|
495
|
+
}
|
|
496
|
+
}
|
|
497
|
+
}
|
|
498
|
+
},
|
|
499
|
+
"subscribers_stats": {
|
|
500
|
+
"verb": "get",
|
|
501
|
+
"path": "/v4/subscribers/{subscriber_id}/stats",
|
|
502
|
+
"key": "subscriber",
|
|
503
|
+
"kind": "object",
|
|
504
|
+
"type": "subscriber_stats",
|
|
505
|
+
"responses": {
|
|
506
|
+
"200": {
|
|
507
|
+
"subscriber": {
|
|
508
|
+
"id": 1103,
|
|
509
|
+
"stats": {
|
|
510
|
+
"sent": 2,
|
|
511
|
+
"opened": 1,
|
|
512
|
+
"clicked": 1,
|
|
513
|
+
"bounced": 1,
|
|
514
|
+
"open_rate": 0.5,
|
|
515
|
+
"click_rate": 0.5,
|
|
516
|
+
"last_sent": "2025-07-13T12:00:00Z",
|
|
517
|
+
"last_opened": "2025-07-13T12:00:00Z",
|
|
518
|
+
"last_clicked": "2025-07-14T12:00:00Z",
|
|
519
|
+
"sends_since_last_open": 0,
|
|
520
|
+
"sends_since_last_click": 0
|
|
521
|
+
}
|
|
522
|
+
}
|
|
523
|
+
}
|
|
524
|
+
}
|
|
525
|
+
},
|
|
526
|
+
"subscribers_set_location": {
|
|
527
|
+
"verb": "post",
|
|
528
|
+
"path": "/v4/subscribers/{subscriber_id}/location",
|
|
529
|
+
"key": "subscriber",
|
|
530
|
+
"kind": "object",
|
|
531
|
+
"type": "subscriber",
|
|
532
|
+
"responses": {
|
|
533
|
+
"200": {
|
|
534
|
+
"subscriber": {
|
|
535
|
+
"id": 1100,
|
|
536
|
+
"location": {
|
|
537
|
+
"city": "Boise",
|
|
538
|
+
"state_province": "Idaho",
|
|
539
|
+
"country_code": "US",
|
|
540
|
+
"latitude": 43.62,
|
|
541
|
+
"longitude": -116.2,
|
|
542
|
+
"timezone": "America/Denver"
|
|
543
|
+
}
|
|
544
|
+
}
|
|
545
|
+
}
|
|
546
|
+
}
|
|
547
|
+
},
|
|
548
|
+
"subscribers_update_location": {
|
|
549
|
+
"verb": "patch",
|
|
550
|
+
"path": "/v4/subscribers/{subscriber_id}/location",
|
|
551
|
+
"key": "subscriber",
|
|
552
|
+
"kind": "object",
|
|
553
|
+
"type": "subscriber",
|
|
554
|
+
"responses": {
|
|
555
|
+
"200": {
|
|
556
|
+
"subscriber": {
|
|
557
|
+
"id": 1128,
|
|
558
|
+
"location": {
|
|
559
|
+
"city": "Boise",
|
|
560
|
+
"state_province": "Idaho",
|
|
561
|
+
"country_code": "US",
|
|
562
|
+
"latitude": 43.62,
|
|
563
|
+
"longitude": -116.2,
|
|
564
|
+
"timezone": "America/Denver"
|
|
565
|
+
}
|
|
566
|
+
}
|
|
567
|
+
}
|
|
568
|
+
}
|
|
569
|
+
},
|
|
570
|
+
"subscribers_remove_location": {
|
|
571
|
+
"verb": "delete",
|
|
572
|
+
"path": "/v4/subscribers/{subscriber_id}/location",
|
|
573
|
+
"key": null,
|
|
574
|
+
"kind": "none",
|
|
575
|
+
"type": null,
|
|
576
|
+
"responses": {
|
|
577
|
+
"204": null
|
|
578
|
+
}
|
|
579
|
+
},
|
|
580
|
+
"tags_list": {
|
|
581
|
+
"verb": "get",
|
|
582
|
+
"path": "/v4/tags",
|
|
583
|
+
"key": "tags",
|
|
584
|
+
"kind": "list",
|
|
585
|
+
"type": "tag",
|
|
586
|
+
"responses": {
|
|
587
|
+
"200": {
|
|
588
|
+
"tags": [
|
|
589
|
+
{
|
|
590
|
+
"id": 12,
|
|
591
|
+
"name": "Tag B",
|
|
592
|
+
"created_at": "2023-02-17T11:43:55Z"
|
|
593
|
+
},
|
|
594
|
+
{
|
|
595
|
+
"id": 11,
|
|
596
|
+
"name": "Tag A",
|
|
597
|
+
"created_at": "2023-02-17T11:43:55Z"
|
|
598
|
+
}
|
|
599
|
+
],
|
|
600
|
+
"pagination": {
|
|
601
|
+
"has_previous_page": false,
|
|
602
|
+
"has_next_page": false,
|
|
603
|
+
"start_cursor": "MTI=",
|
|
604
|
+
"end_cursor": "MTE=",
|
|
605
|
+
"per_page": 500
|
|
606
|
+
}
|
|
607
|
+
}
|
|
608
|
+
}
|
|
609
|
+
},
|
|
610
|
+
"tags_create": {
|
|
611
|
+
"verb": "post",
|
|
612
|
+
"path": "/v4/tags",
|
|
613
|
+
"key": "tag",
|
|
614
|
+
"kind": "object",
|
|
615
|
+
"type": "tag",
|
|
616
|
+
"responses": {
|
|
617
|
+
"200": {
|
|
618
|
+
"tag": {
|
|
619
|
+
"id": 26,
|
|
620
|
+
"name": "Completed",
|
|
621
|
+
"created_at": "2023-02-17T11:43:55Z"
|
|
622
|
+
}
|
|
623
|
+
},
|
|
624
|
+
"201": {
|
|
625
|
+
"tag": {
|
|
626
|
+
"id": 25,
|
|
627
|
+
"name": "Completed",
|
|
628
|
+
"created_at": "2023-02-17T11:43:55Z"
|
|
629
|
+
}
|
|
630
|
+
}
|
|
631
|
+
}
|
|
632
|
+
},
|
|
633
|
+
"tags_update": {
|
|
634
|
+
"verb": "put",
|
|
635
|
+
"path": "/v4/tags/{id}",
|
|
636
|
+
"key": "tag",
|
|
637
|
+
"kind": "object",
|
|
638
|
+
"type": "tag",
|
|
639
|
+
"responses": {
|
|
640
|
+
"200": {
|
|
641
|
+
"tag": {
|
|
642
|
+
"id": 44,
|
|
643
|
+
"name": "signed up",
|
|
644
|
+
"created_at": "2023-02-17T11:43:55Z"
|
|
645
|
+
}
|
|
646
|
+
}
|
|
647
|
+
}
|
|
648
|
+
},
|
|
649
|
+
"tags_subscribers": {
|
|
650
|
+
"verb": "get",
|
|
651
|
+
"path": "/v4/tags/{tag_id}/subscribers",
|
|
652
|
+
"key": "subscribers",
|
|
653
|
+
"kind": "list",
|
|
654
|
+
"type": "subscriber",
|
|
655
|
+
"responses": {
|
|
656
|
+
"200": {
|
|
657
|
+
"subscribers": [
|
|
658
|
+
{
|
|
659
|
+
"id": 1140,
|
|
660
|
+
"first_name": null,
|
|
661
|
+
"email_address": "subscriber634@kit.dev",
|
|
662
|
+
"state": "active",
|
|
663
|
+
"created_at": "2023-02-17T11:43:55Z",
|
|
664
|
+
"tagged_at": "2023-02-17T11:43:55Z",
|
|
665
|
+
"fields": {
|
|
666
|
+
"category": "One"
|
|
667
|
+
}
|
|
668
|
+
},
|
|
669
|
+
{
|
|
670
|
+
"id": 1139,
|
|
671
|
+
"first_name": null,
|
|
672
|
+
"email_address": "subscriber633@kit.dev",
|
|
673
|
+
"state": "active",
|
|
674
|
+
"created_at": "2023-02-17T11:43:55Z",
|
|
675
|
+
"tagged_at": "2023-02-17T11:43:55Z",
|
|
676
|
+
"fields": {
|
|
677
|
+
"category": null
|
|
678
|
+
}
|
|
679
|
+
},
|
|
680
|
+
{
|
|
681
|
+
"id": 1138,
|
|
682
|
+
"first_name": null,
|
|
683
|
+
"email_address": "subscriber632@kit.dev",
|
|
684
|
+
"state": "active",
|
|
685
|
+
"created_at": "2023-02-17T11:43:55Z",
|
|
686
|
+
"tagged_at": "2023-02-17T11:43:55Z",
|
|
687
|
+
"fields": {
|
|
688
|
+
"category": null
|
|
689
|
+
}
|
|
690
|
+
}
|
|
691
|
+
],
|
|
692
|
+
"pagination": {
|
|
693
|
+
"has_previous_page": false,
|
|
694
|
+
"has_next_page": false,
|
|
695
|
+
"start_cursor": "WyIyMDIzLTAyLTE3VDExOjQzOjU1LjAwMFoiLDE3XQ==",
|
|
696
|
+
"end_cursor": "WyIyMDIzLTAyLTE3VDExOjQzOjU1LjAwMFoiLDE1XQ==",
|
|
697
|
+
"per_page": 500
|
|
698
|
+
}
|
|
699
|
+
}
|
|
700
|
+
}
|
|
701
|
+
},
|
|
702
|
+
"tags_tag_subscriber": {
|
|
703
|
+
"verb": "post",
|
|
704
|
+
"path": "/v4/tags/{tag_id}/subscribers/{id}",
|
|
705
|
+
"key": "subscriber",
|
|
706
|
+
"kind": "object",
|
|
707
|
+
"type": "subscriber",
|
|
708
|
+
"responses": {
|
|
709
|
+
"200": {
|
|
710
|
+
"subscriber": {
|
|
711
|
+
"id": 1256,
|
|
712
|
+
"first_name": "Alice",
|
|
713
|
+
"email_address": "alice@convertkit.dev",
|
|
714
|
+
"state": "active",
|
|
715
|
+
"created_at": "2023-02-17T11:43:55Z",
|
|
716
|
+
"tagged_at": "2023-02-17T11:43:55Z",
|
|
717
|
+
"fields": {}
|
|
718
|
+
}
|
|
719
|
+
},
|
|
720
|
+
"201": {
|
|
721
|
+
"subscriber": {
|
|
722
|
+
"id": 1257,
|
|
723
|
+
"first_name": "Alice",
|
|
724
|
+
"email_address": "alice@convertkit.dev",
|
|
725
|
+
"state": "active",
|
|
726
|
+
"created_at": "2023-02-17T11:43:55Z",
|
|
727
|
+
"tagged_at": "2023-02-17T11:43:55Z",
|
|
728
|
+
"fields": {}
|
|
729
|
+
}
|
|
730
|
+
}
|
|
731
|
+
}
|
|
732
|
+
},
|
|
733
|
+
"tags_remove_subscriber": {
|
|
734
|
+
"verb": "delete",
|
|
735
|
+
"path": "/v4/tags/{tag_id}/subscribers/{id}",
|
|
736
|
+
"key": null,
|
|
737
|
+
"kind": "none",
|
|
738
|
+
"type": null,
|
|
739
|
+
"responses": {
|
|
740
|
+
"204": null
|
|
741
|
+
}
|
|
742
|
+
},
|
|
743
|
+
"tags_tag_subscriber_by_email": {
|
|
744
|
+
"verb": "post",
|
|
745
|
+
"path": "/v4/tags/{tag_id}/subscribers",
|
|
746
|
+
"key": "subscriber",
|
|
747
|
+
"kind": "object",
|
|
748
|
+
"type": "subscriber",
|
|
749
|
+
"responses": {
|
|
750
|
+
"200": {
|
|
751
|
+
"subscriber": {
|
|
752
|
+
"id": 1276,
|
|
753
|
+
"first_name": "Alice",
|
|
754
|
+
"email_address": "alice@convertkit.dev",
|
|
755
|
+
"state": "active",
|
|
756
|
+
"created_at": "2023-02-17T11:43:55Z",
|
|
757
|
+
"tagged_at": "2023-02-17T11:43:55Z",
|
|
758
|
+
"fields": {}
|
|
759
|
+
}
|
|
760
|
+
},
|
|
761
|
+
"201": {
|
|
762
|
+
"subscriber": {
|
|
763
|
+
"id": 1277,
|
|
764
|
+
"first_name": "Alice",
|
|
765
|
+
"email_address": "alice@convertkit.dev",
|
|
766
|
+
"state": "active",
|
|
767
|
+
"created_at": "2023-02-17T11:43:55Z",
|
|
768
|
+
"tagged_at": "2023-02-17T11:43:55Z",
|
|
769
|
+
"fields": {}
|
|
770
|
+
}
|
|
771
|
+
}
|
|
772
|
+
}
|
|
773
|
+
},
|
|
774
|
+
"tags_remove_subscriber_by_email": {
|
|
775
|
+
"verb": "delete",
|
|
776
|
+
"path": "/v4/tags/{tag_id}/subscribers",
|
|
777
|
+
"key": null,
|
|
778
|
+
"kind": "none",
|
|
779
|
+
"type": null,
|
|
780
|
+
"responses": {
|
|
781
|
+
"204": null
|
|
782
|
+
}
|
|
783
|
+
},
|
|
784
|
+
"custom_fields_list": {
|
|
785
|
+
"verb": "get",
|
|
786
|
+
"path": "/v4/custom_fields",
|
|
787
|
+
"key": "custom_fields",
|
|
788
|
+
"kind": "list",
|
|
789
|
+
"type": "custom_field",
|
|
790
|
+
"responses": {
|
|
791
|
+
"200": {
|
|
792
|
+
"custom_fields": [
|
|
793
|
+
{
|
|
794
|
+
"id": 1,
|
|
795
|
+
"name": "ck_field_1_last_name",
|
|
796
|
+
"key": "last_name",
|
|
797
|
+
"label": "Last name"
|
|
798
|
+
}
|
|
799
|
+
],
|
|
800
|
+
"pagination": {
|
|
801
|
+
"has_previous_page": false,
|
|
802
|
+
"has_next_page": false,
|
|
803
|
+
"start_cursor": "WzFd",
|
|
804
|
+
"end_cursor": "WzFd",
|
|
805
|
+
"per_page": 500
|
|
806
|
+
}
|
|
807
|
+
}
|
|
808
|
+
}
|
|
809
|
+
},
|
|
810
|
+
"custom_fields_create": {
|
|
811
|
+
"verb": "post",
|
|
812
|
+
"path": "/v4/custom_fields",
|
|
813
|
+
"key": "custom_field",
|
|
814
|
+
"kind": "object",
|
|
815
|
+
"type": "custom_field",
|
|
816
|
+
"responses": {
|
|
817
|
+
"200": {
|
|
818
|
+
"custom_field": {
|
|
819
|
+
"id": 8,
|
|
820
|
+
"name": "ck_field_8_interests",
|
|
821
|
+
"key": "interests",
|
|
822
|
+
"label": "Interests"
|
|
823
|
+
}
|
|
824
|
+
},
|
|
825
|
+
"201": {
|
|
826
|
+
"custom_field": {
|
|
827
|
+
"id": 6,
|
|
828
|
+
"name": "ck_field_6_interests",
|
|
829
|
+
"key": "interests",
|
|
830
|
+
"label": "Interests"
|
|
831
|
+
}
|
|
832
|
+
}
|
|
833
|
+
}
|
|
834
|
+
},
|
|
835
|
+
"custom_fields_update": {
|
|
836
|
+
"verb": "put",
|
|
837
|
+
"path": "/v4/custom_fields/{id}",
|
|
838
|
+
"key": "custom_field",
|
|
839
|
+
"kind": "object",
|
|
840
|
+
"type": "custom_field",
|
|
841
|
+
"responses": {
|
|
842
|
+
"200": {
|
|
843
|
+
"custom_field": {
|
|
844
|
+
"id": 27,
|
|
845
|
+
"name": "ck_field_27_last_name",
|
|
846
|
+
"key": "lastname",
|
|
847
|
+
"label": "Last name"
|
|
848
|
+
}
|
|
849
|
+
}
|
|
850
|
+
}
|
|
851
|
+
},
|
|
852
|
+
"custom_fields_delete": {
|
|
853
|
+
"verb": "delete",
|
|
854
|
+
"path": "/v4/custom_fields/{id}",
|
|
855
|
+
"key": null,
|
|
856
|
+
"kind": "none",
|
|
857
|
+
"type": null,
|
|
858
|
+
"responses": {
|
|
859
|
+
"204": null
|
|
860
|
+
}
|
|
861
|
+
},
|
|
862
|
+
"forms_list": {
|
|
863
|
+
"verb": "get",
|
|
864
|
+
"path": "/v4/forms",
|
|
865
|
+
"key": "forms",
|
|
866
|
+
"kind": "list",
|
|
867
|
+
"type": "form",
|
|
868
|
+
"responses": {
|
|
869
|
+
"200": {
|
|
870
|
+
"forms": [
|
|
871
|
+
{
|
|
872
|
+
"id": 53,
|
|
873
|
+
"name": "Sign up",
|
|
874
|
+
"created_at": "2023-02-17T11:43:55Z",
|
|
875
|
+
"type": "embed",
|
|
876
|
+
"format": null,
|
|
877
|
+
"embed_js": "https://kit-greetings.kit.com/f049e3d9ab/index.js",
|
|
878
|
+
"embed_url": "https://kit-greetings.kit.com/f049e3d9ab",
|
|
879
|
+
"archived": false,
|
|
880
|
+
"uid": "f049e3d9ab"
|
|
881
|
+
},
|
|
882
|
+
{
|
|
883
|
+
"id": 52,
|
|
884
|
+
"name": "Lead gen",
|
|
885
|
+
"created_at": "2023-02-17T11:43:55Z",
|
|
886
|
+
"type": "hosted",
|
|
887
|
+
"format": null,
|
|
888
|
+
"embed_js": "https://kit-greetings.kit.com/ae7c1adaa1/index.js",
|
|
889
|
+
"embed_url": "https://kit-greetings.kit.com/ae7c1adaa1",
|
|
890
|
+
"archived": false,
|
|
891
|
+
"uid": "ae7c1adaa1"
|
|
892
|
+
}
|
|
893
|
+
],
|
|
894
|
+
"pagination": {
|
|
895
|
+
"has_previous_page": false,
|
|
896
|
+
"has_next_page": false,
|
|
897
|
+
"start_cursor": "WzUzXQ==",
|
|
898
|
+
"end_cursor": "WzUyXQ==",
|
|
899
|
+
"per_page": 500
|
|
900
|
+
}
|
|
901
|
+
}
|
|
902
|
+
}
|
|
903
|
+
},
|
|
904
|
+
"forms_subscribers": {
|
|
905
|
+
"verb": "get",
|
|
906
|
+
"path": "/v4/forms/{form_id}/subscribers",
|
|
907
|
+
"key": "subscribers",
|
|
908
|
+
"kind": "list",
|
|
909
|
+
"type": "subscriber",
|
|
910
|
+
"responses": {
|
|
911
|
+
"200": {
|
|
912
|
+
"subscribers": [
|
|
913
|
+
{
|
|
914
|
+
"id": 680,
|
|
915
|
+
"first_name": null,
|
|
916
|
+
"email_address": "subscriber359@kit.dev",
|
|
917
|
+
"state": "active",
|
|
918
|
+
"created_at": "2023-02-17T11:43:55Z",
|
|
919
|
+
"added_at": "2023-02-17T11:43:55Z",
|
|
920
|
+
"referrer": "https://mywebsite.com/bfpromo/?utm_source=facebook&utm_medium=cpc&utm_campaign=black_friday&utm_term=car_owners&utm_content=get_10_off",
|
|
921
|
+
"referrer_utm_parameters": {
|
|
922
|
+
"source": "facebook",
|
|
923
|
+
"medium": "cpc",
|
|
924
|
+
"campaign": "black_friday",
|
|
925
|
+
"term": "car_owners",
|
|
926
|
+
"content": "get_10_off"
|
|
927
|
+
},
|
|
928
|
+
"fields": {
|
|
929
|
+
"category": "One"
|
|
930
|
+
}
|
|
931
|
+
},
|
|
932
|
+
{
|
|
933
|
+
"id": 679,
|
|
934
|
+
"first_name": null,
|
|
935
|
+
"email_address": "subscriber358@kit.dev",
|
|
936
|
+
"state": "active",
|
|
937
|
+
"created_at": "2023-02-17T11:43:55Z",
|
|
938
|
+
"added_at": "2023-02-17T11:43:55Z",
|
|
939
|
+
"referrer": "https://mywebsite.com/bfpromo/?utm_source=facebook&utm_medium=cpc&utm_campaign=black_friday&utm_term=car_owners&utm_content=get_10_off",
|
|
940
|
+
"referrer_utm_parameters": {
|
|
941
|
+
"source": "facebook",
|
|
942
|
+
"medium": "cpc",
|
|
943
|
+
"campaign": "black_friday",
|
|
944
|
+
"term": "car_owners",
|
|
945
|
+
"content": "get_10_off"
|
|
946
|
+
},
|
|
947
|
+
"fields": {
|
|
948
|
+
"category": null
|
|
949
|
+
}
|
|
950
|
+
},
|
|
951
|
+
{
|
|
952
|
+
"id": 678,
|
|
953
|
+
"first_name": null,
|
|
954
|
+
"email_address": "subscriber357@kit.dev",
|
|
955
|
+
"state": "active",
|
|
956
|
+
"created_at": "2023-02-17T11:43:55Z",
|
|
957
|
+
"added_at": "2023-02-17T11:43:55Z",
|
|
958
|
+
"referrer": "https://mywebsite.com/bfpromo/?utm_source=facebook&utm_medium=cpc&utm_campaign=black_friday&utm_term=car_owners&utm_content=get_10_off",
|
|
959
|
+
"referrer_utm_parameters": {
|
|
960
|
+
"source": "facebook",
|
|
961
|
+
"medium": "cpc",
|
|
962
|
+
"campaign": "black_friday",
|
|
963
|
+
"term": "car_owners",
|
|
964
|
+
"content": "get_10_off"
|
|
965
|
+
},
|
|
966
|
+
"fields": {
|
|
967
|
+
"category": null
|
|
968
|
+
}
|
|
969
|
+
}
|
|
970
|
+
],
|
|
971
|
+
"pagination": {
|
|
972
|
+
"has_previous_page": false,
|
|
973
|
+
"has_next_page": false,
|
|
974
|
+
"start_cursor": "WzY4MF0=",
|
|
975
|
+
"end_cursor": "WzY3OF0=",
|
|
976
|
+
"per_page": 500
|
|
977
|
+
}
|
|
978
|
+
}
|
|
979
|
+
}
|
|
980
|
+
},
|
|
981
|
+
"forms_add_subscriber": {
|
|
982
|
+
"verb": "post",
|
|
983
|
+
"path": "/v4/forms/{form_id}/subscribers/{id}",
|
|
984
|
+
"key": "subscriber",
|
|
985
|
+
"kind": "object",
|
|
986
|
+
"type": "subscriber",
|
|
987
|
+
"responses": {
|
|
988
|
+
"200": {
|
|
989
|
+
"subscriber": {
|
|
990
|
+
"id": 767,
|
|
991
|
+
"first_name": "Alice",
|
|
992
|
+
"email_address": "alice@convertkit.dev",
|
|
993
|
+
"state": "active",
|
|
994
|
+
"created_at": "2023-02-17T11:43:55Z",
|
|
995
|
+
"added_at": "2023-02-17T11:43:55Z",
|
|
996
|
+
"fields": {},
|
|
997
|
+
"referrer": "https://mywebsite.com/bfpromo/?utm_source=facebook&utm_medium=cpc&utm_campaign=black_friday&utm_term=car_owners&utm_content=get_10_off",
|
|
998
|
+
"referrer_utm_parameters": {
|
|
999
|
+
"source": "facebook",
|
|
1000
|
+
"medium": "cpc",
|
|
1001
|
+
"campaign": "black_friday",
|
|
1002
|
+
"term": "car_owners",
|
|
1003
|
+
"content": "get_10_off"
|
|
1004
|
+
}
|
|
1005
|
+
}
|
|
1006
|
+
},
|
|
1007
|
+
"201": {
|
|
1008
|
+
"subscriber": {
|
|
1009
|
+
"id": 768,
|
|
1010
|
+
"first_name": "Alice",
|
|
1011
|
+
"email_address": "alice@convertkit.dev",
|
|
1012
|
+
"state": "active",
|
|
1013
|
+
"created_at": "2023-02-17T11:43:55Z",
|
|
1014
|
+
"added_at": "2023-02-17T11:43:55Z",
|
|
1015
|
+
"fields": {},
|
|
1016
|
+
"referrer": "https://mywebsite.com/bfpromo/?utm_source=facebook&utm_medium=cpc&utm_campaign=black_friday&utm_term=car_owners&utm_content=get_10_off",
|
|
1017
|
+
"referrer_utm_parameters": {
|
|
1018
|
+
"source": "facebook",
|
|
1019
|
+
"medium": "cpc",
|
|
1020
|
+
"campaign": "black_friday",
|
|
1021
|
+
"term": "car_owners",
|
|
1022
|
+
"content": "get_10_off"
|
|
1023
|
+
}
|
|
1024
|
+
}
|
|
1025
|
+
}
|
|
1026
|
+
}
|
|
1027
|
+
},
|
|
1028
|
+
"forms_add_subscriber_by_email": {
|
|
1029
|
+
"verb": "post",
|
|
1030
|
+
"path": "/v4/forms/{form_id}/subscribers",
|
|
1031
|
+
"key": "subscriber",
|
|
1032
|
+
"kind": "object",
|
|
1033
|
+
"type": "subscriber",
|
|
1034
|
+
"responses": {
|
|
1035
|
+
"200": {
|
|
1036
|
+
"subscriber": {
|
|
1037
|
+
"id": 790,
|
|
1038
|
+
"first_name": "Alice",
|
|
1039
|
+
"email_address": "alice@convertkit.dev",
|
|
1040
|
+
"state": "active",
|
|
1041
|
+
"created_at": "2023-02-17T11:43:55Z",
|
|
1042
|
+
"added_at": "2023-02-17T11:43:55Z",
|
|
1043
|
+
"fields": {},
|
|
1044
|
+
"referrer": "https://mywebsite.com/bfpromo/?utm_source=facebook&utm_medium=cpc&utm_campaign=black_friday&utm_term=car_owners&utm_content=get_10_off",
|
|
1045
|
+
"referrer_utm_parameters": {
|
|
1046
|
+
"source": "facebook",
|
|
1047
|
+
"medium": "cpc",
|
|
1048
|
+
"campaign": "black_friday",
|
|
1049
|
+
"term": "car_owners",
|
|
1050
|
+
"content": "get_10_off"
|
|
1051
|
+
}
|
|
1052
|
+
}
|
|
1053
|
+
},
|
|
1054
|
+
"201": {
|
|
1055
|
+
"subscriber": {
|
|
1056
|
+
"id": 791,
|
|
1057
|
+
"first_name": "Alice",
|
|
1058
|
+
"email_address": "alice@convertkit.dev",
|
|
1059
|
+
"state": "active",
|
|
1060
|
+
"created_at": "2023-02-17T11:43:55Z",
|
|
1061
|
+
"added_at": "2023-02-17T11:43:55Z",
|
|
1062
|
+
"fields": {},
|
|
1063
|
+
"referrer": "https://mywebsite.com/bfpromo/?utm_source=facebook&utm_medium=cpc&utm_campaign=black_friday&utm_term=car_owners&utm_content=get_10_off",
|
|
1064
|
+
"referrer_utm_parameters": {
|
|
1065
|
+
"source": "facebook",
|
|
1066
|
+
"medium": "cpc",
|
|
1067
|
+
"campaign": "black_friday",
|
|
1068
|
+
"term": "car_owners",
|
|
1069
|
+
"content": "get_10_off"
|
|
1070
|
+
}
|
|
1071
|
+
}
|
|
1072
|
+
}
|
|
1073
|
+
}
|
|
1074
|
+
},
|
|
1075
|
+
"sequences_list": {
|
|
1076
|
+
"verb": "get",
|
|
1077
|
+
"path": "/v4/sequences",
|
|
1078
|
+
"key": "sequences",
|
|
1079
|
+
"kind": "list",
|
|
1080
|
+
"type": "sequence",
|
|
1081
|
+
"responses": {
|
|
1082
|
+
"200": {
|
|
1083
|
+
"sequences": [
|
|
1084
|
+
{
|
|
1085
|
+
"id": 1,
|
|
1086
|
+
"name": "Evergreen sequence",
|
|
1087
|
+
"hold": false,
|
|
1088
|
+
"repeat": false,
|
|
1089
|
+
"created_at": "2023-02-17T11:43:55Z",
|
|
1090
|
+
"updated_at": "2023-02-17T11:43:55Z",
|
|
1091
|
+
"email_address": null,
|
|
1092
|
+
"email_template_id": null,
|
|
1093
|
+
"email_count": 0,
|
|
1094
|
+
"subscriber_count": 0,
|
|
1095
|
+
"send_days": [
|
|
1096
|
+
"monday",
|
|
1097
|
+
"tuesday",
|
|
1098
|
+
"wednesday",
|
|
1099
|
+
"thursday",
|
|
1100
|
+
"friday",
|
|
1101
|
+
"saturday",
|
|
1102
|
+
"sunday"
|
|
1103
|
+
],
|
|
1104
|
+
"send_hour": 11,
|
|
1105
|
+
"time_zone": "America/New_York",
|
|
1106
|
+
"active": true,
|
|
1107
|
+
"exclude_subscriber_sources": []
|
|
1108
|
+
}
|
|
1109
|
+
],
|
|
1110
|
+
"pagination": {
|
|
1111
|
+
"has_previous_page": false,
|
|
1112
|
+
"has_next_page": false,
|
|
1113
|
+
"start_cursor": "WzFd",
|
|
1114
|
+
"end_cursor": "WzFd",
|
|
1115
|
+
"per_page": 500
|
|
1116
|
+
}
|
|
1117
|
+
}
|
|
1118
|
+
}
|
|
1119
|
+
},
|
|
1120
|
+
"sequences_create": {
|
|
1121
|
+
"verb": "post",
|
|
1122
|
+
"path": "/v4/sequences",
|
|
1123
|
+
"key": "sequence",
|
|
1124
|
+
"kind": "object",
|
|
1125
|
+
"type": "sequence",
|
|
1126
|
+
"responses": {
|
|
1127
|
+
"201": {
|
|
1128
|
+
"sequence": {
|
|
1129
|
+
"id": 31,
|
|
1130
|
+
"name": "Full Series",
|
|
1131
|
+
"hold": true,
|
|
1132
|
+
"repeat": true,
|
|
1133
|
+
"created_at": "2026-07-28T03:01:49Z",
|
|
1134
|
+
"updated_at": "2026-07-28T03:01:49Z",
|
|
1135
|
+
"email_address": "joe1150@ck.lol",
|
|
1136
|
+
"email_template_id": 38,
|
|
1137
|
+
"send_days": [
|
|
1138
|
+
"monday",
|
|
1139
|
+
"wednesday",
|
|
1140
|
+
"friday"
|
|
1141
|
+
],
|
|
1142
|
+
"send_hour": 9,
|
|
1143
|
+
"time_zone": "America/Los_Angeles",
|
|
1144
|
+
"active": true,
|
|
1145
|
+
"exclude_subscriber_sources": [
|
|
1146
|
+
{
|
|
1147
|
+
"type": "sequence",
|
|
1148
|
+
"ids": [
|
|
1149
|
+
30
|
|
1150
|
+
]
|
|
1151
|
+
},
|
|
1152
|
+
{
|
|
1153
|
+
"type": "tag",
|
|
1154
|
+
"ids": [
|
|
1155
|
+
3
|
|
1156
|
+
]
|
|
1157
|
+
}
|
|
1158
|
+
],
|
|
1159
|
+
"email_count": 0,
|
|
1160
|
+
"subscriber_count": 0
|
|
1161
|
+
}
|
|
1162
|
+
}
|
|
1163
|
+
}
|
|
1164
|
+
},
|
|
1165
|
+
"sequences_get": {
|
|
1166
|
+
"verb": "get",
|
|
1167
|
+
"path": "/v4/sequences/{id}",
|
|
1168
|
+
"key": "sequence",
|
|
1169
|
+
"kind": "object",
|
|
1170
|
+
"type": "sequence",
|
|
1171
|
+
"responses": {
|
|
1172
|
+
"200": {
|
|
1173
|
+
"sequence": {
|
|
1174
|
+
"id": 23,
|
|
1175
|
+
"name": "Welcome sequence",
|
|
1176
|
+
"hold": false,
|
|
1177
|
+
"repeat": false,
|
|
1178
|
+
"created_at": "2023-02-17T11:43:55Z",
|
|
1179
|
+
"updated_at": "2023-02-17T11:43:55Z",
|
|
1180
|
+
"email_address": null,
|
|
1181
|
+
"email_template_id": null,
|
|
1182
|
+
"send_days": [
|
|
1183
|
+
"monday",
|
|
1184
|
+
"tuesday",
|
|
1185
|
+
"wednesday",
|
|
1186
|
+
"thursday",
|
|
1187
|
+
"friday",
|
|
1188
|
+
"saturday",
|
|
1189
|
+
"sunday"
|
|
1190
|
+
],
|
|
1191
|
+
"send_hour": 11,
|
|
1192
|
+
"time_zone": "America/New_York",
|
|
1193
|
+
"active": true,
|
|
1194
|
+
"exclude_subscriber_sources": [],
|
|
1195
|
+
"email_count": 0,
|
|
1196
|
+
"subscriber_count": 0
|
|
1197
|
+
}
|
|
1198
|
+
}
|
|
1199
|
+
}
|
|
1200
|
+
},
|
|
1201
|
+
"sequences_update": {
|
|
1202
|
+
"verb": "put",
|
|
1203
|
+
"path": "/v4/sequences/{id}",
|
|
1204
|
+
"key": "sequence",
|
|
1205
|
+
"kind": "object",
|
|
1206
|
+
"type": "sequence",
|
|
1207
|
+
"responses": {
|
|
1208
|
+
"200": {
|
|
1209
|
+
"sequence": {
|
|
1210
|
+
"id": 50,
|
|
1211
|
+
"name": "New Name",
|
|
1212
|
+
"hold": true,
|
|
1213
|
+
"repeat": true,
|
|
1214
|
+
"created_at": "2026-07-28T03:01:51Z",
|
|
1215
|
+
"updated_at": "2026-07-28T03:01:52Z",
|
|
1216
|
+
"email_address": "joe1180@ck.lol",
|
|
1217
|
+
"email_template_id": 40,
|
|
1218
|
+
"send_days": [
|
|
1219
|
+
"tuesday",
|
|
1220
|
+
"thursday"
|
|
1221
|
+
],
|
|
1222
|
+
"send_hour": 14,
|
|
1223
|
+
"time_zone": "America/Chicago",
|
|
1224
|
+
"active": false,
|
|
1225
|
+
"exclude_subscriber_sources": [
|
|
1226
|
+
{
|
|
1227
|
+
"type": "sequence",
|
|
1228
|
+
"ids": [
|
|
1229
|
+
49
|
|
1230
|
+
]
|
|
1231
|
+
},
|
|
1232
|
+
{
|
|
1233
|
+
"type": "tag",
|
|
1234
|
+
"ids": [
|
|
1235
|
+
4
|
|
1236
|
+
]
|
|
1237
|
+
}
|
|
1238
|
+
],
|
|
1239
|
+
"email_count": 0,
|
|
1240
|
+
"subscriber_count": 0
|
|
1241
|
+
}
|
|
1242
|
+
}
|
|
1243
|
+
}
|
|
1244
|
+
},
|
|
1245
|
+
"sequences_delete": {
|
|
1246
|
+
"verb": "delete",
|
|
1247
|
+
"path": "/v4/sequences/{id}",
|
|
1248
|
+
"key": null,
|
|
1249
|
+
"kind": "none",
|
|
1250
|
+
"type": null,
|
|
1251
|
+
"responses": {
|
|
1252
|
+
"204": null
|
|
1253
|
+
}
|
|
1254
|
+
},
|
|
1255
|
+
"sequences_subscribers": {
|
|
1256
|
+
"verb": "get",
|
|
1257
|
+
"path": "/v4/sequences/{sequence_id}/subscribers",
|
|
1258
|
+
"key": "subscribers",
|
|
1259
|
+
"kind": "list",
|
|
1260
|
+
"type": "subscriber",
|
|
1261
|
+
"responses": {
|
|
1262
|
+
"200": {
|
|
1263
|
+
"subscribers": [
|
|
1264
|
+
{
|
|
1265
|
+
"id": 923,
|
|
1266
|
+
"first_name": null,
|
|
1267
|
+
"email_address": "subscriber494@kit.dev",
|
|
1268
|
+
"state": "active",
|
|
1269
|
+
"created_at": "2023-02-17T11:43:55Z",
|
|
1270
|
+
"added_at": "2023-02-17T11:43:55Z",
|
|
1271
|
+
"fields": {
|
|
1272
|
+
"category": "One"
|
|
1273
|
+
}
|
|
1274
|
+
},
|
|
1275
|
+
{
|
|
1276
|
+
"id": 922,
|
|
1277
|
+
"first_name": null,
|
|
1278
|
+
"email_address": "subscriber493@kit.dev",
|
|
1279
|
+
"state": "active",
|
|
1280
|
+
"created_at": "2023-02-17T11:43:55Z",
|
|
1281
|
+
"added_at": "2023-02-17T11:43:55Z",
|
|
1282
|
+
"fields": {
|
|
1283
|
+
"category": null
|
|
1284
|
+
}
|
|
1285
|
+
},
|
|
1286
|
+
{
|
|
1287
|
+
"id": 921,
|
|
1288
|
+
"first_name": null,
|
|
1289
|
+
"email_address": "subscriber492@kit.dev",
|
|
1290
|
+
"state": "active",
|
|
1291
|
+
"created_at": "2023-02-17T11:43:55Z",
|
|
1292
|
+
"added_at": "2023-02-17T11:43:55Z",
|
|
1293
|
+
"fields": {
|
|
1294
|
+
"category": null
|
|
1295
|
+
}
|
|
1296
|
+
}
|
|
1297
|
+
],
|
|
1298
|
+
"pagination": {
|
|
1299
|
+
"has_previous_page": false,
|
|
1300
|
+
"has_next_page": false,
|
|
1301
|
+
"start_cursor": "WzkyM10=",
|
|
1302
|
+
"end_cursor": "WzkyMV0=",
|
|
1303
|
+
"per_page": 500
|
|
1304
|
+
}
|
|
1305
|
+
}
|
|
1306
|
+
}
|
|
1307
|
+
},
|
|
1308
|
+
"sequences_add_subscriber": {
|
|
1309
|
+
"verb": "post",
|
|
1310
|
+
"path": "/v4/sequences/{sequence_id}/subscribers/{id}",
|
|
1311
|
+
"key": "subscriber",
|
|
1312
|
+
"kind": "object",
|
|
1313
|
+
"type": "subscriber",
|
|
1314
|
+
"responses": {
|
|
1315
|
+
"200": {
|
|
1316
|
+
"subscriber": {
|
|
1317
|
+
"id": 1008,
|
|
1318
|
+
"first_name": "Alice",
|
|
1319
|
+
"email_address": "alice@convertkit.dev",
|
|
1320
|
+
"state": "active",
|
|
1321
|
+
"created_at": "2023-02-17T11:43:55Z",
|
|
1322
|
+
"added_at": "2023-02-17T11:43:55Z",
|
|
1323
|
+
"fields": {}
|
|
1324
|
+
}
|
|
1325
|
+
},
|
|
1326
|
+
"201": {
|
|
1327
|
+
"subscriber": {
|
|
1328
|
+
"id": 1009,
|
|
1329
|
+
"first_name": "Alice",
|
|
1330
|
+
"email_address": "alice@convertkit.dev",
|
|
1331
|
+
"state": "active",
|
|
1332
|
+
"created_at": "2023-02-17T11:43:55Z",
|
|
1333
|
+
"added_at": "2023-02-17T11:43:55Z",
|
|
1334
|
+
"fields": {}
|
|
1335
|
+
}
|
|
1336
|
+
}
|
|
1337
|
+
}
|
|
1338
|
+
},
|
|
1339
|
+
"sequences_add_subscriber_by_email": {
|
|
1340
|
+
"verb": "post",
|
|
1341
|
+
"path": "/v4/sequences/{sequence_id}/subscribers",
|
|
1342
|
+
"key": "subscriber",
|
|
1343
|
+
"kind": "object",
|
|
1344
|
+
"type": "subscriber",
|
|
1345
|
+
"responses": {
|
|
1346
|
+
"200": {
|
|
1347
|
+
"subscriber": {
|
|
1348
|
+
"id": 1034,
|
|
1349
|
+
"first_name": "Alice",
|
|
1350
|
+
"email_address": "alice@convertkit.dev",
|
|
1351
|
+
"state": "active",
|
|
1352
|
+
"created_at": "2023-02-17T11:43:55Z",
|
|
1353
|
+
"added_at": "2023-02-17T11:43:55Z",
|
|
1354
|
+
"fields": {}
|
|
1355
|
+
}
|
|
1356
|
+
},
|
|
1357
|
+
"201": {
|
|
1358
|
+
"subscriber": {
|
|
1359
|
+
"id": 1035,
|
|
1360
|
+
"first_name": "Alice",
|
|
1361
|
+
"email_address": "alice@convertkit.dev",
|
|
1362
|
+
"state": "active",
|
|
1363
|
+
"created_at": "2023-02-17T11:43:55Z",
|
|
1364
|
+
"added_at": "2023-02-17T11:43:55Z",
|
|
1365
|
+
"fields": {}
|
|
1366
|
+
}
|
|
1367
|
+
}
|
|
1368
|
+
}
|
|
1369
|
+
},
|
|
1370
|
+
"sequences_emails": {
|
|
1371
|
+
"verb": "get",
|
|
1372
|
+
"path": "/v4/sequences/{sequence_id}/emails",
|
|
1373
|
+
"key": "emails",
|
|
1374
|
+
"kind": "list",
|
|
1375
|
+
"type": "sequence_email",
|
|
1376
|
+
"responses": {
|
|
1377
|
+
"200": {
|
|
1378
|
+
"emails": [
|
|
1379
|
+
{
|
|
1380
|
+
"id": 6,
|
|
1381
|
+
"sequence_id": 108,
|
|
1382
|
+
"subject": "Welcome to the series",
|
|
1383
|
+
"preview_text": "Here's what to expect",
|
|
1384
|
+
"email_address": "joe2790@ck.lol",
|
|
1385
|
+
"email_template_id": null,
|
|
1386
|
+
"published": true,
|
|
1387
|
+
"position": 0,
|
|
1388
|
+
"delay_value": 0,
|
|
1389
|
+
"delay_unit": "days",
|
|
1390
|
+
"send_days": [
|
|
1391
|
+
"monday",
|
|
1392
|
+
"tuesday",
|
|
1393
|
+
"wednesday",
|
|
1394
|
+
"thursday",
|
|
1395
|
+
"friday",
|
|
1396
|
+
"saturday",
|
|
1397
|
+
"sunday"
|
|
1398
|
+
]
|
|
1399
|
+
}
|
|
1400
|
+
],
|
|
1401
|
+
"pagination": {
|
|
1402
|
+
"has_previous_page": false,
|
|
1403
|
+
"has_next_page": false,
|
|
1404
|
+
"start_cursor": "WzAsNl0=",
|
|
1405
|
+
"end_cursor": "WzAsNl0=",
|
|
1406
|
+
"per_page": 500
|
|
1407
|
+
}
|
|
1408
|
+
}
|
|
1409
|
+
}
|
|
1410
|
+
},
|
|
1411
|
+
"sequences_create_email": {
|
|
1412
|
+
"verb": "post",
|
|
1413
|
+
"path": "/v4/sequences/{sequence_id}/emails",
|
|
1414
|
+
"key": "email",
|
|
1415
|
+
"kind": "object",
|
|
1416
|
+
"type": "sequence_email",
|
|
1417
|
+
"responses": {
|
|
1418
|
+
"201": {
|
|
1419
|
+
"email": {
|
|
1420
|
+
"id": 38,
|
|
1421
|
+
"sequence_id": 157,
|
|
1422
|
+
"subject": "Welcome to the sequence",
|
|
1423
|
+
"preview_text": null,
|
|
1424
|
+
"email_address": "joe2857@ck.lol",
|
|
1425
|
+
"email_template_id": null,
|
|
1426
|
+
"published": false,
|
|
1427
|
+
"position": 0,
|
|
1428
|
+
"delay_value": 1,
|
|
1429
|
+
"delay_unit": "days",
|
|
1430
|
+
"send_days": [
|
|
1431
|
+
"monday",
|
|
1432
|
+
"tuesday",
|
|
1433
|
+
"wednesday",
|
|
1434
|
+
"thursday",
|
|
1435
|
+
"friday",
|
|
1436
|
+
"saturday",
|
|
1437
|
+
"sunday"
|
|
1438
|
+
],
|
|
1439
|
+
"content": null
|
|
1440
|
+
}
|
|
1441
|
+
}
|
|
1442
|
+
}
|
|
1443
|
+
},
|
|
1444
|
+
"sequences_email": {
|
|
1445
|
+
"verb": "get",
|
|
1446
|
+
"path": "/v4/sequences/{sequence_id}/emails/{id}",
|
|
1447
|
+
"key": "email",
|
|
1448
|
+
"kind": "object",
|
|
1449
|
+
"type": "sequence_email",
|
|
1450
|
+
"responses": {
|
|
1451
|
+
"200": {
|
|
1452
|
+
"email": {
|
|
1453
|
+
"id": 26,
|
|
1454
|
+
"sequence_id": 130,
|
|
1455
|
+
"subject": "Welcome email",
|
|
1456
|
+
"preview_text": "Thanks for signing up",
|
|
1457
|
+
"email_address": "joe2821@ck.lol",
|
|
1458
|
+
"email_template_id": null,
|
|
1459
|
+
"published": true,
|
|
1460
|
+
"position": 0,
|
|
1461
|
+
"delay_value": 0,
|
|
1462
|
+
"delay_unit": "days",
|
|
1463
|
+
"send_days": [
|
|
1464
|
+
"monday",
|
|
1465
|
+
"tuesday",
|
|
1466
|
+
"wednesday",
|
|
1467
|
+
"thursday",
|
|
1468
|
+
"friday",
|
|
1469
|
+
"saturday",
|
|
1470
|
+
"sunday"
|
|
1471
|
+
],
|
|
1472
|
+
"content": "<p>Welcome!</p>"
|
|
1473
|
+
}
|
|
1474
|
+
}
|
|
1475
|
+
}
|
|
1476
|
+
},
|
|
1477
|
+
"sequences_update_email": {
|
|
1478
|
+
"verb": "put",
|
|
1479
|
+
"path": "/v4/sequences/{sequence_id}/emails/{id}",
|
|
1480
|
+
"key": "email",
|
|
1481
|
+
"kind": "object",
|
|
1482
|
+
"type": "sequence_email",
|
|
1483
|
+
"responses": {
|
|
1484
|
+
"200": {
|
|
1485
|
+
"email": {
|
|
1486
|
+
"id": 78,
|
|
1487
|
+
"sequence_id": 197,
|
|
1488
|
+
"subject": "Updated subject",
|
|
1489
|
+
"preview_text": "Updated preview",
|
|
1490
|
+
"email_address": "joe2906@ck.lol",
|
|
1491
|
+
"email_template_id": null,
|
|
1492
|
+
"published": true,
|
|
1493
|
+
"position": null,
|
|
1494
|
+
"delay_value": 3,
|
|
1495
|
+
"delay_unit": "days",
|
|
1496
|
+
"send_days": [
|
|
1497
|
+
"monday",
|
|
1498
|
+
"wednesday",
|
|
1499
|
+
"friday"
|
|
1500
|
+
],
|
|
1501
|
+
"content": "Content 44"
|
|
1502
|
+
}
|
|
1503
|
+
}
|
|
1504
|
+
}
|
|
1505
|
+
},
|
|
1506
|
+
"sequences_delete_email": {
|
|
1507
|
+
"verb": "delete",
|
|
1508
|
+
"path": "/v4/sequences/{sequence_id}/emails/{id}",
|
|
1509
|
+
"key": null,
|
|
1510
|
+
"kind": "none",
|
|
1511
|
+
"type": null,
|
|
1512
|
+
"responses": {
|
|
1513
|
+
"204": null
|
|
1514
|
+
}
|
|
1515
|
+
},
|
|
1516
|
+
"broadcasts_list": {
|
|
1517
|
+
"verb": "get",
|
|
1518
|
+
"path": "/v4/broadcasts",
|
|
1519
|
+
"key": "broadcasts",
|
|
1520
|
+
"kind": "list",
|
|
1521
|
+
"type": "broadcast",
|
|
1522
|
+
"responses": {
|
|
1523
|
+
"200": {
|
|
1524
|
+
"broadcasts": [
|
|
1525
|
+
{
|
|
1526
|
+
"id": 3,
|
|
1527
|
+
"publication_id": 3,
|
|
1528
|
+
"created_at": "2023-02-17T11:43:55Z",
|
|
1529
|
+
"subject": "Campaign subject 3",
|
|
1530
|
+
"preview_text": null,
|
|
1531
|
+
"description": null,
|
|
1532
|
+
"public": false,
|
|
1533
|
+
"published_at": null,
|
|
1534
|
+
"send_at": null,
|
|
1535
|
+
"status": "draft",
|
|
1536
|
+
"thumbnail_alt": null,
|
|
1537
|
+
"thumbnail_url": null,
|
|
1538
|
+
"content": null,
|
|
1539
|
+
"public_url": null,
|
|
1540
|
+
"email_address": "greetings@kit.dev",
|
|
1541
|
+
"email_template": {
|
|
1542
|
+
"id": 6,
|
|
1543
|
+
"name": "Text Only"
|
|
1544
|
+
},
|
|
1545
|
+
"subscriber_filter": [
|
|
1546
|
+
{
|
|
1547
|
+
"all": [
|
|
1548
|
+
{
|
|
1549
|
+
"type": "all_subscribers"
|
|
1550
|
+
}
|
|
1551
|
+
]
|
|
1552
|
+
}
|
|
1553
|
+
]
|
|
1554
|
+
},
|
|
1555
|
+
{
|
|
1556
|
+
"id": 2,
|
|
1557
|
+
"publication_id": 2,
|
|
1558
|
+
"created_at": "2023-02-17T11:43:55Z",
|
|
1559
|
+
"subject": "Campaign subject 2",
|
|
1560
|
+
"preview_text": null,
|
|
1561
|
+
"description": null,
|
|
1562
|
+
"public": false,
|
|
1563
|
+
"published_at": null,
|
|
1564
|
+
"send_at": null,
|
|
1565
|
+
"status": "draft",
|
|
1566
|
+
"thumbnail_alt": null,
|
|
1567
|
+
"thumbnail_url": null,
|
|
1568
|
+
"content": null,
|
|
1569
|
+
"public_url": null,
|
|
1570
|
+
"email_address": "greetings@kit.dev",
|
|
1571
|
+
"email_template": {
|
|
1572
|
+
"id": 6,
|
|
1573
|
+
"name": "Text Only"
|
|
1574
|
+
},
|
|
1575
|
+
"subscriber_filter": [
|
|
1576
|
+
{
|
|
1577
|
+
"all": [
|
|
1578
|
+
{
|
|
1579
|
+
"type": "all_subscribers"
|
|
1580
|
+
}
|
|
1581
|
+
]
|
|
1582
|
+
}
|
|
1583
|
+
]
|
|
1584
|
+
},
|
|
1585
|
+
{
|
|
1586
|
+
"id": 1,
|
|
1587
|
+
"publication_id": 1,
|
|
1588
|
+
"created_at": "2023-02-17T11:43:55Z",
|
|
1589
|
+
"subject": "Campaign subject 1",
|
|
1590
|
+
"preview_text": null,
|
|
1591
|
+
"description": null,
|
|
1592
|
+
"public": false,
|
|
1593
|
+
"published_at": null,
|
|
1594
|
+
"send_at": null,
|
|
1595
|
+
"status": "draft",
|
|
1596
|
+
"thumbnail_alt": null,
|
|
1597
|
+
"thumbnail_url": null,
|
|
1598
|
+
"content": null,
|
|
1599
|
+
"public_url": null,
|
|
1600
|
+
"email_address": "greetings@kit.dev",
|
|
1601
|
+
"email_template": {
|
|
1602
|
+
"id": 6,
|
|
1603
|
+
"name": "Text Only"
|
|
1604
|
+
},
|
|
1605
|
+
"subscriber_filter": [
|
|
1606
|
+
{
|
|
1607
|
+
"all": [
|
|
1608
|
+
{
|
|
1609
|
+
"type": "all_subscribers"
|
|
1610
|
+
}
|
|
1611
|
+
]
|
|
1612
|
+
}
|
|
1613
|
+
]
|
|
1614
|
+
}
|
|
1615
|
+
],
|
|
1616
|
+
"pagination": {
|
|
1617
|
+
"has_previous_page": false,
|
|
1618
|
+
"has_next_page": false,
|
|
1619
|
+
"start_cursor": "WzNd",
|
|
1620
|
+
"end_cursor": "WzFd",
|
|
1621
|
+
"per_page": 500
|
|
1622
|
+
}
|
|
1623
|
+
}
|
|
1624
|
+
}
|
|
1625
|
+
},
|
|
1626
|
+
"broadcasts_create": {
|
|
1627
|
+
"verb": "post",
|
|
1628
|
+
"path": "/v4/broadcasts",
|
|
1629
|
+
"key": "broadcast",
|
|
1630
|
+
"kind": "object",
|
|
1631
|
+
"type": "broadcast",
|
|
1632
|
+
"responses": {
|
|
1633
|
+
"201": {
|
|
1634
|
+
"broadcast": {
|
|
1635
|
+
"id": 64,
|
|
1636
|
+
"publication_id": 55,
|
|
1637
|
+
"created_at": "2023-02-17T11:43:55Z",
|
|
1638
|
+
"subject": "Hello!",
|
|
1639
|
+
"preview_text": "Pleased to meet you!",
|
|
1640
|
+
"description": "Intro email",
|
|
1641
|
+
"content": "<p>Let me introduce myself</p>",
|
|
1642
|
+
"public": true,
|
|
1643
|
+
"published_at": "2023-02-17T11:43:55Z",
|
|
1644
|
+
"send_at": null,
|
|
1645
|
+
"thumbnail_alt": null,
|
|
1646
|
+
"thumbnail_url": null,
|
|
1647
|
+
"public_url": "https://kit-greetings.kit.com/posts/",
|
|
1648
|
+
"email_address": "greetings@kit.dev",
|
|
1649
|
+
"email_template": {
|
|
1650
|
+
"id": 2,
|
|
1651
|
+
"name": "Classic"
|
|
1652
|
+
},
|
|
1653
|
+
"subscriber_filter": [
|
|
1654
|
+
{
|
|
1655
|
+
"all": [
|
|
1656
|
+
{
|
|
1657
|
+
"type": "segment",
|
|
1658
|
+
"ids": [
|
|
1659
|
+
18
|
|
1660
|
+
]
|
|
1661
|
+
}
|
|
1662
|
+
]
|
|
1663
|
+
}
|
|
1664
|
+
],
|
|
1665
|
+
"status": "draft"
|
|
1666
|
+
}
|
|
1667
|
+
}
|
|
1668
|
+
}
|
|
1669
|
+
},
|
|
1670
|
+
"broadcasts_get": {
|
|
1671
|
+
"verb": "get",
|
|
1672
|
+
"path": "/v4/broadcasts/{id}",
|
|
1673
|
+
"key": "broadcast",
|
|
1674
|
+
"kind": "object",
|
|
1675
|
+
"type": "broadcast",
|
|
1676
|
+
"responses": {
|
|
1677
|
+
"200": {
|
|
1678
|
+
"broadcast": {
|
|
1679
|
+
"id": 57,
|
|
1680
|
+
"publication_id": 48,
|
|
1681
|
+
"created_at": "2023-02-17T11:43:55Z",
|
|
1682
|
+
"subject": "You'll never guess...",
|
|
1683
|
+
"preview_text": null,
|
|
1684
|
+
"description": null,
|
|
1685
|
+
"content": null,
|
|
1686
|
+
"public": false,
|
|
1687
|
+
"published_at": null,
|
|
1688
|
+
"send_at": null,
|
|
1689
|
+
"thumbnail_alt": null,
|
|
1690
|
+
"thumbnail_url": null,
|
|
1691
|
+
"public_url": null,
|
|
1692
|
+
"email_address": "greetings@kit.dev",
|
|
1693
|
+
"email_template": {
|
|
1694
|
+
"id": 6,
|
|
1695
|
+
"name": "Text Only"
|
|
1696
|
+
},
|
|
1697
|
+
"subscriber_filter": [
|
|
1698
|
+
{
|
|
1699
|
+
"all": [
|
|
1700
|
+
{
|
|
1701
|
+
"type": "all_subscribers"
|
|
1702
|
+
}
|
|
1703
|
+
]
|
|
1704
|
+
}
|
|
1705
|
+
],
|
|
1706
|
+
"status": "draft"
|
|
1707
|
+
}
|
|
1708
|
+
}
|
|
1709
|
+
}
|
|
1710
|
+
},
|
|
1711
|
+
"broadcasts_update": {
|
|
1712
|
+
"verb": "put",
|
|
1713
|
+
"path": "/v4/broadcasts/{id}",
|
|
1714
|
+
"key": "broadcast",
|
|
1715
|
+
"kind": "object",
|
|
1716
|
+
"type": "broadcast",
|
|
1717
|
+
"responses": {
|
|
1718
|
+
"200": {
|
|
1719
|
+
"broadcast": {
|
|
1720
|
+
"id": 92,
|
|
1721
|
+
"publication_id": 83,
|
|
1722
|
+
"created_at": "2023-02-17T11:43:55Z",
|
|
1723
|
+
"subject": "Hello!",
|
|
1724
|
+
"preview_text": "Pleased to meet you!",
|
|
1725
|
+
"description": "Intro email",
|
|
1726
|
+
"content": "<p>Let me introduce myself</p>",
|
|
1727
|
+
"public": true,
|
|
1728
|
+
"published_at": "2023-02-17T11:43:55Z",
|
|
1729
|
+
"send_at": "2023-02-17T11:43:55Z",
|
|
1730
|
+
"thumbnail_alt": null,
|
|
1731
|
+
"thumbnail_url": null,
|
|
1732
|
+
"public_url": "https://kit-greetings.kit.com/posts/hello",
|
|
1733
|
+
"email_address": "greetings@kit.dev",
|
|
1734
|
+
"email_template": {
|
|
1735
|
+
"id": 2,
|
|
1736
|
+
"name": "Classic"
|
|
1737
|
+
},
|
|
1738
|
+
"subscriber_filter": [
|
|
1739
|
+
{
|
|
1740
|
+
"all": [
|
|
1741
|
+
{
|
|
1742
|
+
"type": "segment",
|
|
1743
|
+
"ids": [
|
|
1744
|
+
54
|
|
1745
|
+
]
|
|
1746
|
+
}
|
|
1747
|
+
]
|
|
1748
|
+
}
|
|
1749
|
+
],
|
|
1750
|
+
"status": "sending"
|
|
1751
|
+
}
|
|
1752
|
+
}
|
|
1753
|
+
}
|
|
1754
|
+
},
|
|
1755
|
+
"broadcasts_delete": {
|
|
1756
|
+
"verb": "delete",
|
|
1757
|
+
"path": "/v4/broadcasts/{id}",
|
|
1758
|
+
"key": null,
|
|
1759
|
+
"kind": "none",
|
|
1760
|
+
"type": null,
|
|
1761
|
+
"responses": {
|
|
1762
|
+
"204": null
|
|
1763
|
+
}
|
|
1764
|
+
},
|
|
1765
|
+
"broadcasts_stats_list": {
|
|
1766
|
+
"verb": "get",
|
|
1767
|
+
"path": "/v4/broadcasts/stats",
|
|
1768
|
+
"key": "broadcasts",
|
|
1769
|
+
"kind": "list",
|
|
1770
|
+
"type": "broadcast_stats",
|
|
1771
|
+
"responses": {
|
|
1772
|
+
"200": {
|
|
1773
|
+
"broadcasts": [
|
|
1774
|
+
{
|
|
1775
|
+
"id": 205,
|
|
1776
|
+
"subject": "... or will you",
|
|
1777
|
+
"send_at": null,
|
|
1778
|
+
"stats": {
|
|
1779
|
+
"recipients": 0,
|
|
1780
|
+
"open_rate": 0.0,
|
|
1781
|
+
"emails_opened": 0,
|
|
1782
|
+
"click_rate": 0.0,
|
|
1783
|
+
"unsubscribe_rate": 0.0,
|
|
1784
|
+
"unsubscribes": 0,
|
|
1785
|
+
"total_clicks": 0,
|
|
1786
|
+
"show_total_clicks": false,
|
|
1787
|
+
"status": "draft",
|
|
1788
|
+
"progress": 0.0,
|
|
1789
|
+
"open_tracking_disabled": false,
|
|
1790
|
+
"click_tracking_disabled": false
|
|
1791
|
+
}
|
|
1792
|
+
},
|
|
1793
|
+
{
|
|
1794
|
+
"id": 204,
|
|
1795
|
+
"subject": "You'll never guess...",
|
|
1796
|
+
"send_at": null,
|
|
1797
|
+
"stats": {
|
|
1798
|
+
"recipients": 0,
|
|
1799
|
+
"open_rate": 0.0,
|
|
1800
|
+
"emails_opened": 0,
|
|
1801
|
+
"click_rate": 0.0,
|
|
1802
|
+
"unsubscribe_rate": 0.0,
|
|
1803
|
+
"unsubscribes": 0,
|
|
1804
|
+
"total_clicks": 0,
|
|
1805
|
+
"show_total_clicks": false,
|
|
1806
|
+
"status": "draft",
|
|
1807
|
+
"progress": 0.0,
|
|
1808
|
+
"open_tracking_disabled": false,
|
|
1809
|
+
"click_tracking_disabled": false
|
|
1810
|
+
}
|
|
1811
|
+
}
|
|
1812
|
+
],
|
|
1813
|
+
"pagination": {
|
|
1814
|
+
"has_previous_page": false,
|
|
1815
|
+
"has_next_page": false,
|
|
1816
|
+
"start_cursor": "WzIwNV0=",
|
|
1817
|
+
"end_cursor": "WzIwNF0=",
|
|
1818
|
+
"per_page": 500
|
|
1819
|
+
}
|
|
1820
|
+
}
|
|
1821
|
+
}
|
|
1822
|
+
},
|
|
1823
|
+
"broadcasts_stats": {
|
|
1824
|
+
"verb": "get",
|
|
1825
|
+
"path": "/v4/broadcasts/{broadcast_id}/stats",
|
|
1826
|
+
"key": "broadcast",
|
|
1827
|
+
"kind": "object",
|
|
1828
|
+
"type": "broadcast_stats",
|
|
1829
|
+
"responses": {
|
|
1830
|
+
"200": {
|
|
1831
|
+
"broadcast": {
|
|
1832
|
+
"id": 270,
|
|
1833
|
+
"stats": {
|
|
1834
|
+
"recipients": 0,
|
|
1835
|
+
"open_rate": 0.0,
|
|
1836
|
+
"emails_opened": 0,
|
|
1837
|
+
"click_rate": 0.0,
|
|
1838
|
+
"unsubscribe_rate": 0.0,
|
|
1839
|
+
"unsubscribes": 0,
|
|
1840
|
+
"total_clicks": 0,
|
|
1841
|
+
"show_total_clicks": false,
|
|
1842
|
+
"status": "draft",
|
|
1843
|
+
"progress": 0.0,
|
|
1844
|
+
"open_tracking_disabled": false,
|
|
1845
|
+
"click_tracking_disabled": false
|
|
1846
|
+
}
|
|
1847
|
+
}
|
|
1848
|
+
}
|
|
1849
|
+
}
|
|
1850
|
+
},
|
|
1851
|
+
"broadcasts_clicks": {
|
|
1852
|
+
"verb": "get",
|
|
1853
|
+
"path": "/v4/broadcasts/{broadcast_id}/clicks",
|
|
1854
|
+
"key": null,
|
|
1855
|
+
"kind": "raw",
|
|
1856
|
+
"type": null,
|
|
1857
|
+
"responses": {
|
|
1858
|
+
"200": {
|
|
1859
|
+
"broadcast": {
|
|
1860
|
+
"id": 171,
|
|
1861
|
+
"clicks": [
|
|
1862
|
+
{
|
|
1863
|
+
"id": 52,
|
|
1864
|
+
"url": "https://example.com/52",
|
|
1865
|
+
"unique_clicks": 3,
|
|
1866
|
+
"click_to_delivery_rate": 0.006,
|
|
1867
|
+
"click_to_open_rate": 0.03
|
|
1868
|
+
},
|
|
1869
|
+
{
|
|
1870
|
+
"id": 53,
|
|
1871
|
+
"url": "https://example.com/53",
|
|
1872
|
+
"unique_clicks": 3,
|
|
1873
|
+
"click_to_delivery_rate": 0.006,
|
|
1874
|
+
"click_to_open_rate": 0.03
|
|
1875
|
+
},
|
|
1876
|
+
{
|
|
1877
|
+
"id": 54,
|
|
1878
|
+
"url": "https://example.com/54",
|
|
1879
|
+
"unique_clicks": 3,
|
|
1880
|
+
"click_to_delivery_rate": 0.006,
|
|
1881
|
+
"click_to_open_rate": 0.03
|
|
1882
|
+
}
|
|
1883
|
+
]
|
|
1884
|
+
},
|
|
1885
|
+
"pagination": {
|
|
1886
|
+
"has_previous_page": false,
|
|
1887
|
+
"has_next_page": false,
|
|
1888
|
+
"start_cursor": "WzE4XQ==",
|
|
1889
|
+
"end_cursor": "WzE4XQ==",
|
|
1890
|
+
"per_page": 500
|
|
1891
|
+
}
|
|
1892
|
+
}
|
|
1893
|
+
}
|
|
1894
|
+
},
|
|
1895
|
+
"email_templates_list": {
|
|
1896
|
+
"verb": "get",
|
|
1897
|
+
"path": "/v4/email_templates",
|
|
1898
|
+
"key": "email_templates",
|
|
1899
|
+
"kind": "list",
|
|
1900
|
+
"type": "email_template",
|
|
1901
|
+
"responses": {
|
|
1902
|
+
"200": {
|
|
1903
|
+
"email_templates": [
|
|
1904
|
+
{
|
|
1905
|
+
"id": 36,
|
|
1906
|
+
"name": "Custom HTML Template",
|
|
1907
|
+
"is_default": false,
|
|
1908
|
+
"category": "HTML"
|
|
1909
|
+
},
|
|
1910
|
+
{
|
|
1911
|
+
"id": 35,
|
|
1912
|
+
"name": "Story",
|
|
1913
|
+
"is_default": false,
|
|
1914
|
+
"category": "Starting point"
|
|
1915
|
+
},
|
|
1916
|
+
{
|
|
1917
|
+
"id": 6,
|
|
1918
|
+
"name": "Text Only",
|
|
1919
|
+
"is_default": true,
|
|
1920
|
+
"category": "HTML"
|
|
1921
|
+
},
|
|
1922
|
+
{
|
|
1923
|
+
"id": 4,
|
|
1924
|
+
"name": "Modern",
|
|
1925
|
+
"is_default": false,
|
|
1926
|
+
"category": "HTML"
|
|
1927
|
+
},
|
|
1928
|
+
{
|
|
1929
|
+
"id": 2,
|
|
1930
|
+
"name": "Classic",
|
|
1931
|
+
"is_default": false,
|
|
1932
|
+
"category": "HTML"
|
|
1933
|
+
},
|
|
1934
|
+
{
|
|
1935
|
+
"id": 1,
|
|
1936
|
+
"name": "Card",
|
|
1937
|
+
"is_default": false,
|
|
1938
|
+
"category": "HTML"
|
|
1939
|
+
}
|
|
1940
|
+
],
|
|
1941
|
+
"pagination": {
|
|
1942
|
+
"has_previous_page": false,
|
|
1943
|
+
"has_next_page": false,
|
|
1944
|
+
"start_cursor": "WzM2XQ==",
|
|
1945
|
+
"end_cursor": "WzFd",
|
|
1946
|
+
"per_page": 500
|
|
1947
|
+
}
|
|
1948
|
+
}
|
|
1949
|
+
}
|
|
1950
|
+
},
|
|
1951
|
+
"segments_list": {
|
|
1952
|
+
"verb": "get",
|
|
1953
|
+
"path": "/v4/segments",
|
|
1954
|
+
"key": "segments",
|
|
1955
|
+
"kind": "list",
|
|
1956
|
+
"type": "segment",
|
|
1957
|
+
"responses": {
|
|
1958
|
+
"200": {
|
|
1959
|
+
"segments": [
|
|
1960
|
+
{
|
|
1961
|
+
"id": 75,
|
|
1962
|
+
"name": "Segment B",
|
|
1963
|
+
"created_at": "2023-02-17T11:43:55Z"
|
|
1964
|
+
},
|
|
1965
|
+
{
|
|
1966
|
+
"id": 74,
|
|
1967
|
+
"name": "Segment A",
|
|
1968
|
+
"created_at": "2023-02-17T11:43:55Z"
|
|
1969
|
+
}
|
|
1970
|
+
],
|
|
1971
|
+
"pagination": {
|
|
1972
|
+
"has_previous_page": false,
|
|
1973
|
+
"has_next_page": false,
|
|
1974
|
+
"start_cursor": "Wzc1XQ==",
|
|
1975
|
+
"end_cursor": "Wzc0XQ==",
|
|
1976
|
+
"per_page": 500
|
|
1977
|
+
}
|
|
1978
|
+
}
|
|
1979
|
+
}
|
|
1980
|
+
},
|
|
1981
|
+
"posts_list": {
|
|
1982
|
+
"verb": "get",
|
|
1983
|
+
"path": "/v4/posts",
|
|
1984
|
+
"key": "posts",
|
|
1985
|
+
"kind": "list",
|
|
1986
|
+
"type": "post",
|
|
1987
|
+
"responses": {
|
|
1988
|
+
"200": {
|
|
1989
|
+
"posts": [
|
|
1990
|
+
{
|
|
1991
|
+
"id": 3,
|
|
1992
|
+
"publication_id": 127,
|
|
1993
|
+
"created_at": "2026-07-28T03:01:00Z",
|
|
1994
|
+
"title": "Draft Post",
|
|
1995
|
+
"slug": null,
|
|
1996
|
+
"description": null,
|
|
1997
|
+
"meta_description": null,
|
|
1998
|
+
"status": "draft",
|
|
1999
|
+
"published_at": null,
|
|
2000
|
+
"sent_at": null,
|
|
2001
|
+
"thumbnail_alt": null,
|
|
2002
|
+
"thumbnail_url": null,
|
|
2003
|
+
"is_paid": false,
|
|
2004
|
+
"public_url": null
|
|
2005
|
+
},
|
|
2006
|
+
{
|
|
2007
|
+
"id": 2,
|
|
2008
|
+
"publication_id": 126,
|
|
2009
|
+
"created_at": "2026-07-28T03:01:00Z",
|
|
2010
|
+
"title": "Email and Web Post",
|
|
2011
|
+
"slug": "email-and-web-post",
|
|
2012
|
+
"description": null,
|
|
2013
|
+
"meta_description": null,
|
|
2014
|
+
"status": "published",
|
|
2015
|
+
"published_at": "2026-07-26T03:01:00Z",
|
|
2016
|
+
"sent_at": "2026-07-28T03:01:00Z",
|
|
2017
|
+
"thumbnail_alt": null,
|
|
2018
|
+
"thumbnail_url": null,
|
|
2019
|
+
"is_paid": false,
|
|
2020
|
+
"public_url": "https://asdf.kit.com/posts/email-and-web-post"
|
|
2021
|
+
},
|
|
2022
|
+
{
|
|
2023
|
+
"id": 1,
|
|
2024
|
+
"publication_id": 125,
|
|
2025
|
+
"created_at": "2026-07-28T03:01:00Z",
|
|
2026
|
+
"title": "Web Only Post",
|
|
2027
|
+
"slug": "web-only-post",
|
|
2028
|
+
"description": null,
|
|
2029
|
+
"meta_description": null,
|
|
2030
|
+
"status": "published",
|
|
2031
|
+
"published_at": "2026-07-27T03:01:00Z",
|
|
2032
|
+
"sent_at": null,
|
|
2033
|
+
"thumbnail_alt": null,
|
|
2034
|
+
"thumbnail_url": null,
|
|
2035
|
+
"is_paid": false,
|
|
2036
|
+
"public_url": "https://asdf.kit.com/posts/web-only-post"
|
|
2037
|
+
}
|
|
2038
|
+
],
|
|
2039
|
+
"pagination": {
|
|
2040
|
+
"has_previous_page": false,
|
|
2041
|
+
"has_next_page": false,
|
|
2042
|
+
"start_cursor": "WzNd",
|
|
2043
|
+
"end_cursor": "WzFd",
|
|
2044
|
+
"per_page": 500
|
|
2045
|
+
}
|
|
2046
|
+
}
|
|
2047
|
+
}
|
|
2048
|
+
},
|
|
2049
|
+
"posts_get": {
|
|
2050
|
+
"verb": "get",
|
|
2051
|
+
"path": "/v4/posts/{id}",
|
|
2052
|
+
"key": "post",
|
|
2053
|
+
"kind": "object",
|
|
2054
|
+
"type": "post",
|
|
2055
|
+
"responses": {
|
|
2056
|
+
"200": {
|
|
2057
|
+
"post": {
|
|
2058
|
+
"id": 25,
|
|
2059
|
+
"publication_id": 149,
|
|
2060
|
+
"created_at": "2026-07-28T03:01:04Z",
|
|
2061
|
+
"title": "My Newsletter Post",
|
|
2062
|
+
"slug": "my-newsletter-post",
|
|
2063
|
+
"description": null,
|
|
2064
|
+
"meta_description": null,
|
|
2065
|
+
"status": "published",
|
|
2066
|
+
"published_at": "2026-07-27T03:01:04Z",
|
|
2067
|
+
"sent_at": null,
|
|
2068
|
+
"thumbnail_alt": null,
|
|
2069
|
+
"thumbnail_url": null,
|
|
2070
|
+
"is_paid": false,
|
|
2071
|
+
"public_url": "https://asdf.kit.com/posts/my-newsletter-post",
|
|
2072
|
+
"content": "<!DOCTYPE html PUBLIC \"-//W3C//DTD HTML 4.0 Transitional//EN\" \"http://www.w3.org/TR/REC-html40/loose.dtd\">\n<!-- -->\n"
|
|
2073
|
+
}
|
|
2074
|
+
}
|
|
2075
|
+
}
|
|
2076
|
+
},
|
|
2077
|
+
"snippets_list": {
|
|
2078
|
+
"verb": "get",
|
|
2079
|
+
"path": "/v4/snippets",
|
|
2080
|
+
"key": "snippets",
|
|
2081
|
+
"kind": "list",
|
|
2082
|
+
"type": "snippet",
|
|
2083
|
+
"responses": {
|
|
2084
|
+
"200": {
|
|
2085
|
+
"snippets": [
|
|
2086
|
+
{
|
|
2087
|
+
"id": 5,
|
|
2088
|
+
"name": "Welcome message",
|
|
2089
|
+
"snippet_type": "inline",
|
|
2090
|
+
"archived": false,
|
|
2091
|
+
"key": "welcome-message",
|
|
2092
|
+
"created_at": "2023-02-17T11:43:55Z",
|
|
2093
|
+
"updated_at": "2023-02-17T11:43:55Z",
|
|
2094
|
+
"content": "Hello {{ subscriber.first_name }}",
|
|
2095
|
+
"document": {
|
|
2096
|
+
"id": 292,
|
|
2097
|
+
"value": null,
|
|
2098
|
+
"value_html": "content",
|
|
2099
|
+
"value_plain": null,
|
|
2100
|
+
"version": 1
|
|
2101
|
+
}
|
|
2102
|
+
}
|
|
2103
|
+
],
|
|
2104
|
+
"pagination": {
|
|
2105
|
+
"has_previous_page": false,
|
|
2106
|
+
"has_next_page": false,
|
|
2107
|
+
"start_cursor": "WzVd",
|
|
2108
|
+
"end_cursor": "WzVd",
|
|
2109
|
+
"per_page": 500
|
|
2110
|
+
}
|
|
2111
|
+
}
|
|
2112
|
+
}
|
|
2113
|
+
},
|
|
2114
|
+
"snippets_get": {
|
|
2115
|
+
"verb": "get",
|
|
2116
|
+
"path": "/v4/snippets/{id}",
|
|
2117
|
+
"key": "snippet",
|
|
2118
|
+
"kind": "object",
|
|
2119
|
+
"type": "snippet",
|
|
2120
|
+
"responses": {
|
|
2121
|
+
"200": {
|
|
2122
|
+
"snippet": {
|
|
2123
|
+
"id": 24,
|
|
2124
|
+
"name": "Welcome message",
|
|
2125
|
+
"snippet_type": "inline",
|
|
2126
|
+
"archived": false,
|
|
2127
|
+
"key": "welcome-message",
|
|
2128
|
+
"created_at": "2023-02-17T11:43:55Z",
|
|
2129
|
+
"updated_at": "2023-02-17T11:43:55Z",
|
|
2130
|
+
"content": "Hello {{ subscriber.first_name }}",
|
|
2131
|
+
"document": {
|
|
2132
|
+
"id": 311,
|
|
2133
|
+
"value": null,
|
|
2134
|
+
"value_html": "content",
|
|
2135
|
+
"value_plain": null,
|
|
2136
|
+
"version": 1
|
|
2137
|
+
}
|
|
2138
|
+
}
|
|
2139
|
+
}
|
|
2140
|
+
}
|
|
2141
|
+
},
|
|
2142
|
+
"snippets_create": {
|
|
2143
|
+
"verb": "post",
|
|
2144
|
+
"path": "/v4/snippets",
|
|
2145
|
+
"key": "snippet",
|
|
2146
|
+
"kind": "object",
|
|
2147
|
+
"type": "snippet",
|
|
2148
|
+
"responses": {
|
|
2149
|
+
"201": {
|
|
2150
|
+
"snippet": {
|
|
2151
|
+
"id": 31,
|
|
2152
|
+
"name": "Cat Fact of the Day",
|
|
2153
|
+
"snippet_type": "inline",
|
|
2154
|
+
"archived": false,
|
|
2155
|
+
"key": "cat-fact-of-the-day",
|
|
2156
|
+
"created_at": "2026-07-28T03:02:06Z",
|
|
2157
|
+
"updated_at": "2026-07-28T03:02:06Z",
|
|
2158
|
+
"content": "Did you know, {{ subscriber.first_name }}? Cats can rotate their ears 180 degrees.",
|
|
2159
|
+
"document": {
|
|
2160
|
+
"id": 318,
|
|
2161
|
+
"value": null,
|
|
2162
|
+
"value_html": null,
|
|
2163
|
+
"value_plain": null,
|
|
2164
|
+
"version": 1
|
|
2165
|
+
}
|
|
2166
|
+
}
|
|
2167
|
+
}
|
|
2168
|
+
}
|
|
2169
|
+
},
|
|
2170
|
+
"snippets_update": {
|
|
2171
|
+
"verb": "put",
|
|
2172
|
+
"path": "/v4/snippets/{id}",
|
|
2173
|
+
"key": "snippet",
|
|
2174
|
+
"kind": "object",
|
|
2175
|
+
"type": "snippet",
|
|
2176
|
+
"responses": {
|
|
2177
|
+
"200": {
|
|
2178
|
+
"snippet": {
|
|
2179
|
+
"id": 59,
|
|
2180
|
+
"name": "Dog Fact of the Day",
|
|
2181
|
+
"snippet_type": "inline",
|
|
2182
|
+
"archived": false,
|
|
2183
|
+
"key": "welcome-message",
|
|
2184
|
+
"created_at": "2023-02-17T11:43:55Z",
|
|
2185
|
+
"updated_at": "2026-07-28T03:02:11Z",
|
|
2186
|
+
"content": "Hello {{ subscriber.first_name }}",
|
|
2187
|
+
"document": {
|
|
2188
|
+
"id": 346,
|
|
2189
|
+
"value": null,
|
|
2190
|
+
"value_html": "content",
|
|
2191
|
+
"value_plain": null,
|
|
2192
|
+
"version": 1
|
|
2193
|
+
}
|
|
2194
|
+
}
|
|
2195
|
+
}
|
|
2196
|
+
}
|
|
2197
|
+
},
|
|
2198
|
+
"purchases_list": {
|
|
2199
|
+
"verb": "get",
|
|
2200
|
+
"path": "/v4/purchases",
|
|
2201
|
+
"key": "purchases",
|
|
2202
|
+
"kind": "list",
|
|
2203
|
+
"type": "purchase",
|
|
2204
|
+
"responses": {
|
|
2205
|
+
"200": {
|
|
2206
|
+
"purchases": [
|
|
2207
|
+
{
|
|
2208
|
+
"id": 3,
|
|
2209
|
+
"transaction_id": "512-41-4101",
|
|
2210
|
+
"status": "paid",
|
|
2211
|
+
"source": "Gumroad",
|
|
2212
|
+
"email_address": "pru.magoo@convertkit.dev",
|
|
2213
|
+
"subscriber_id": 13,
|
|
2214
|
+
"currency": "USD",
|
|
2215
|
+
"transaction_time": "2023-02-17T11:43:55Z",
|
|
2216
|
+
"subtotal": 5.0,
|
|
2217
|
+
"discount": 0.0,
|
|
2218
|
+
"tax": 0.0,
|
|
2219
|
+
"total": 5.0,
|
|
2220
|
+
"products": [
|
|
2221
|
+
{
|
|
2222
|
+
"quantity": 1,
|
|
2223
|
+
"lid": "000-13-0000",
|
|
2224
|
+
"unit_price": 0.05,
|
|
2225
|
+
"sku": null,
|
|
2226
|
+
"name": "Tip",
|
|
2227
|
+
"pid": "111-75-7524"
|
|
2228
|
+
}
|
|
2229
|
+
]
|
|
2230
|
+
},
|
|
2231
|
+
{
|
|
2232
|
+
"id": 2,
|
|
2233
|
+
"transaction_id": "323-79-5320",
|
|
2234
|
+
"status": "paid",
|
|
2235
|
+
"source": "Gumroad",
|
|
2236
|
+
"email_address": "pru.magoo@convertkit.dev",
|
|
2237
|
+
"subscriber_id": 13,
|
|
2238
|
+
"currency": "USD",
|
|
2239
|
+
"transaction_time": "2023-02-17T11:43:55Z",
|
|
2240
|
+
"subtotal": 10.0,
|
|
2241
|
+
"discount": 0.0,
|
|
2242
|
+
"tax": 1.05,
|
|
2243
|
+
"total": 11.05,
|
|
2244
|
+
"products": [
|
|
2245
|
+
{
|
|
2246
|
+
"quantity": 1,
|
|
2247
|
+
"lid": "000-12-0000",
|
|
2248
|
+
"unit_price": 0.1,
|
|
2249
|
+
"sku": null,
|
|
2250
|
+
"name": "Monthly Game Review",
|
|
2251
|
+
"pid": "000-11-0000"
|
|
2252
|
+
}
|
|
2253
|
+
]
|
|
2254
|
+
},
|
|
2255
|
+
{
|
|
2256
|
+
"id": 1,
|
|
2257
|
+
"transaction_id": "796-92-4892",
|
|
2258
|
+
"status": "paid",
|
|
2259
|
+
"source": "Gumroad",
|
|
2260
|
+
"email_address": "pru.magoo@convertkit.dev",
|
|
2261
|
+
"subscriber_id": 13,
|
|
2262
|
+
"currency": "USD",
|
|
2263
|
+
"transaction_time": "2023-02-17T11:43:55Z",
|
|
2264
|
+
"subtotal": 78.66,
|
|
2265
|
+
"discount": 5.0,
|
|
2266
|
+
"tax": 7.87,
|
|
2267
|
+
"total": 81.53,
|
|
2268
|
+
"products": [
|
|
2269
|
+
{
|
|
2270
|
+
"quantity": 1,
|
|
2271
|
+
"lid": "811-75-7900",
|
|
2272
|
+
"unit_price": 23.22,
|
|
2273
|
+
"sku": null,
|
|
2274
|
+
"name": "Phantom Hourglass",
|
|
2275
|
+
"pid": "804-02-4430"
|
|
2276
|
+
},
|
|
2277
|
+
{
|
|
2278
|
+
"quantity": 1,
|
|
2279
|
+
"lid": "766-49-1241",
|
|
2280
|
+
"unit_price": 32.22,
|
|
2281
|
+
"sku": null,
|
|
2282
|
+
"name": "Twilight Princess",
|
|
2283
|
+
"pid": "833-51-1151"
|
|
2284
|
+
}
|
|
2285
|
+
]
|
|
2286
|
+
}
|
|
2287
|
+
],
|
|
2288
|
+
"pagination": {
|
|
2289
|
+
"has_previous_page": false,
|
|
2290
|
+
"has_next_page": false,
|
|
2291
|
+
"start_cursor": "WzNd",
|
|
2292
|
+
"end_cursor": "WzFd",
|
|
2293
|
+
"per_page": 500
|
|
2294
|
+
}
|
|
2295
|
+
}
|
|
2296
|
+
}
|
|
2297
|
+
},
|
|
2298
|
+
"purchases_get": {
|
|
2299
|
+
"verb": "get",
|
|
2300
|
+
"path": "/v4/purchases/{id}",
|
|
2301
|
+
"key": "purchase",
|
|
2302
|
+
"kind": "object",
|
|
2303
|
+
"type": "purchase",
|
|
2304
|
+
"responses": {
|
|
2305
|
+
"200": {
|
|
2306
|
+
"purchase": {
|
|
2307
|
+
"id": 14,
|
|
2308
|
+
"transaction_id": "796-92-4892",
|
|
2309
|
+
"subscriber_id": 24,
|
|
2310
|
+
"status": "paid",
|
|
2311
|
+
"email_address": "pru.magoo@convertkit.dev",
|
|
2312
|
+
"currency": "USD",
|
|
2313
|
+
"transaction_time": "2023-02-17T11:43:55Z",
|
|
2314
|
+
"subtotal": 78.66,
|
|
2315
|
+
"discount": 5.0,
|
|
2316
|
+
"tax": 7.87,
|
|
2317
|
+
"total": 81.53,
|
|
2318
|
+
"products": [
|
|
2319
|
+
{
|
|
2320
|
+
"quantity": 1,
|
|
2321
|
+
"lid": "811-75-7900",
|
|
2322
|
+
"unit_price": 23.22,
|
|
2323
|
+
"sku": null,
|
|
2324
|
+
"name": "Phantom Hourglass",
|
|
2325
|
+
"pid": "804-02-4430"
|
|
2326
|
+
},
|
|
2327
|
+
{
|
|
2328
|
+
"quantity": 1,
|
|
2329
|
+
"lid": "766-49-1241",
|
|
2330
|
+
"unit_price": 32.22,
|
|
2331
|
+
"sku": null,
|
|
2332
|
+
"name": "Twilight Princess",
|
|
2333
|
+
"pid": "833-51-1151"
|
|
2334
|
+
}
|
|
2335
|
+
],
|
|
2336
|
+
"source": "Gumroad"
|
|
2337
|
+
}
|
|
2338
|
+
}
|
|
2339
|
+
}
|
|
2340
|
+
},
|
|
2341
|
+
"purchases_create": {
|
|
2342
|
+
"verb": "post",
|
|
2343
|
+
"path": "/v4/purchases",
|
|
2344
|
+
"key": "purchase",
|
|
2345
|
+
"kind": "object",
|
|
2346
|
+
"type": "purchase",
|
|
2347
|
+
"responses": {
|
|
2348
|
+
"201": {
|
|
2349
|
+
"purchase": {
|
|
2350
|
+
"id": 22,
|
|
2351
|
+
"transaction_id": "796-92-4892",
|
|
2352
|
+
"subscriber_id": 42,
|
|
2353
|
+
"status": "paid",
|
|
2354
|
+
"email_address": "pru.magoo@convertkit.dev",
|
|
2355
|
+
"currency": "USD",
|
|
2356
|
+
"transaction_time": "2023-02-17T11:43:55Z",
|
|
2357
|
+
"subtotal": 78.66,
|
|
2358
|
+
"discount": 5.0,
|
|
2359
|
+
"tax": 7.87,
|
|
2360
|
+
"total": 81.53,
|
|
2361
|
+
"products": [
|
|
2362
|
+
{
|
|
2363
|
+
"quantity": 1,
|
|
2364
|
+
"lid": "811-75-7900",
|
|
2365
|
+
"unit_price": 23.22,
|
|
2366
|
+
"sku": "SM21-SH-M02-RD-S-001",
|
|
2367
|
+
"name": "Phantom Hourglass",
|
|
2368
|
+
"pid": "804-02-4430"
|
|
2369
|
+
},
|
|
2370
|
+
{
|
|
2371
|
+
"quantity": 1,
|
|
2372
|
+
"lid": "766-49-1241",
|
|
2373
|
+
"unit_price": 32.22,
|
|
2374
|
+
"sku": "WT21-JK-M03-BK-L-012",
|
|
2375
|
+
"name": "Twilight Princess",
|
|
2376
|
+
"pid": "833-51-1151"
|
|
2377
|
+
},
|
|
2378
|
+
{
|
|
2379
|
+
"quantity": 1,
|
|
2380
|
+
"lid": "563-95-8878",
|
|
2381
|
+
"unit_price": 23.22,
|
|
2382
|
+
"sku": "FL21-TS-M01-BL-M-020",
|
|
2383
|
+
"name": "Four Swords",
|
|
2384
|
+
"pid": "217-99-4325"
|
|
2385
|
+
}
|
|
2386
|
+
],
|
|
2387
|
+
"source": "Fancy App 434"
|
|
2388
|
+
}
|
|
2389
|
+
}
|
|
2390
|
+
}
|
|
2391
|
+
},
|
|
2392
|
+
"webhooks_list": {
|
|
2393
|
+
"verb": "get",
|
|
2394
|
+
"path": "/v4/webhooks",
|
|
2395
|
+
"key": "webhooks",
|
|
2396
|
+
"kind": "list",
|
|
2397
|
+
"type": "webhook",
|
|
2398
|
+
"responses": {
|
|
2399
|
+
"200": {
|
|
2400
|
+
"webhooks": [
|
|
2401
|
+
{
|
|
2402
|
+
"id": 2,
|
|
2403
|
+
"account_id": 1776,
|
|
2404
|
+
"event": {
|
|
2405
|
+
"name": "tag_add",
|
|
2406
|
+
"tag_id": 50
|
|
2407
|
+
},
|
|
2408
|
+
"target_url": "http://example.convertkit.dev/tags"
|
|
2409
|
+
},
|
|
2410
|
+
{
|
|
2411
|
+
"id": 1,
|
|
2412
|
+
"account_id": 1776,
|
|
2413
|
+
"event": {
|
|
2414
|
+
"name": "form_subscribe",
|
|
2415
|
+
"form_id": 7
|
|
2416
|
+
},
|
|
2417
|
+
"target_url": "http://example.convertkit.dev/"
|
|
2418
|
+
}
|
|
2419
|
+
],
|
|
2420
|
+
"pagination": {
|
|
2421
|
+
"has_previous_page": false,
|
|
2422
|
+
"has_next_page": false,
|
|
2423
|
+
"start_cursor": "WzJd",
|
|
2424
|
+
"end_cursor": "WzFd",
|
|
2425
|
+
"per_page": 500
|
|
2426
|
+
}
|
|
2427
|
+
}
|
|
2428
|
+
}
|
|
2429
|
+
},
|
|
2430
|
+
"webhooks_create": {
|
|
2431
|
+
"verb": "post",
|
|
2432
|
+
"path": "/v4/webhooks",
|
|
2433
|
+
"key": "webhook",
|
|
2434
|
+
"kind": "object",
|
|
2435
|
+
"type": "webhook",
|
|
2436
|
+
"responses": {
|
|
2437
|
+
"201": {
|
|
2438
|
+
"webhook": {
|
|
2439
|
+
"id": 9,
|
|
2440
|
+
"account_id": 1802,
|
|
2441
|
+
"event": {
|
|
2442
|
+
"name": "subscriber_activate",
|
|
2443
|
+
"initiator_value": null
|
|
2444
|
+
},
|
|
2445
|
+
"target_url": "https://example.convertkit.dev/"
|
|
2446
|
+
}
|
|
2447
|
+
}
|
|
2448
|
+
}
|
|
2449
|
+
},
|
|
2450
|
+
"webhooks_delete": {
|
|
2451
|
+
"verb": "delete",
|
|
2452
|
+
"path": "/v4/webhooks/{id}",
|
|
2453
|
+
"key": null,
|
|
2454
|
+
"kind": "none",
|
|
2455
|
+
"type": null,
|
|
2456
|
+
"responses": {
|
|
2457
|
+
"204": null
|
|
2458
|
+
}
|
|
2459
|
+
},
|
|
2460
|
+
"webhook_endpoints_list": {
|
|
2461
|
+
"verb": "get",
|
|
2462
|
+
"path": "/v4/webhook_endpoints",
|
|
2463
|
+
"key": "webhook_endpoints",
|
|
2464
|
+
"kind": "list",
|
|
2465
|
+
"type": "webhook_endpoint",
|
|
2466
|
+
"responses": {
|
|
2467
|
+
"200": {
|
|
2468
|
+
"webhook_endpoints": [
|
|
2469
|
+
{
|
|
2470
|
+
"id": 2,
|
|
2471
|
+
"name": "My webhook",
|
|
2472
|
+
"url": "https://hooks.example.com/incoming",
|
|
2473
|
+
"events": [
|
|
2474
|
+
"custom_field.created",
|
|
2475
|
+
"subscriber.created"
|
|
2476
|
+
],
|
|
2477
|
+
"status": "active",
|
|
2478
|
+
"source": "creator",
|
|
2479
|
+
"description": "A test webhook",
|
|
2480
|
+
"created_by_app": null,
|
|
2481
|
+
"created_at": "2023-02-17T11:43:55Z",
|
|
2482
|
+
"previous_secret_expires_at": null
|
|
2483
|
+
}
|
|
2484
|
+
],
|
|
2485
|
+
"pagination": {
|
|
2486
|
+
"has_previous_page": false,
|
|
2487
|
+
"has_next_page": false,
|
|
2488
|
+
"start_cursor": "WzJd",
|
|
2489
|
+
"end_cursor": "WzJd",
|
|
2490
|
+
"per_page": 500
|
|
2491
|
+
}
|
|
2492
|
+
}
|
|
2493
|
+
}
|
|
2494
|
+
},
|
|
2495
|
+
"webhook_endpoints_get": {
|
|
2496
|
+
"verb": "get",
|
|
2497
|
+
"path": "/v4/webhook_endpoints/{id}",
|
|
2498
|
+
"key": "webhook_endpoint",
|
|
2499
|
+
"kind": "object",
|
|
2500
|
+
"type": "webhook_endpoint",
|
|
2501
|
+
"responses": {
|
|
2502
|
+
"200": {
|
|
2503
|
+
"webhook_endpoint": {
|
|
2504
|
+
"id": 13,
|
|
2505
|
+
"name": "My webhook",
|
|
2506
|
+
"url": "https://hooks.example.com/incoming",
|
|
2507
|
+
"events": [
|
|
2508
|
+
"subscriber.created"
|
|
2509
|
+
],
|
|
2510
|
+
"status": "active",
|
|
2511
|
+
"source": "creator",
|
|
2512
|
+
"description": "A test webhook",
|
|
2513
|
+
"created_by_app": null,
|
|
2514
|
+
"created_at": "2023-02-17T11:43:55Z",
|
|
2515
|
+
"previous_secret_expires_at": null
|
|
2516
|
+
}
|
|
2517
|
+
}
|
|
2518
|
+
}
|
|
2519
|
+
},
|
|
2520
|
+
"webhook_endpoints_create": {
|
|
2521
|
+
"verb": "post",
|
|
2522
|
+
"path": "/v4/webhook_endpoints",
|
|
2523
|
+
"key": "webhook_endpoint",
|
|
2524
|
+
"kind": "object",
|
|
2525
|
+
"type": "webhook_endpoint",
|
|
2526
|
+
"responses": {
|
|
2527
|
+
"201": {
|
|
2528
|
+
"webhook_endpoint": {
|
|
2529
|
+
"id": 20,
|
|
2530
|
+
"name": "My webhook",
|
|
2531
|
+
"url": "https://hooks.example.com/incoming",
|
|
2532
|
+
"events": [
|
|
2533
|
+
"custom_field.created",
|
|
2534
|
+
"subscriber.created"
|
|
2535
|
+
],
|
|
2536
|
+
"status": "active",
|
|
2537
|
+
"source": "creator",
|
|
2538
|
+
"description": "Listens for things",
|
|
2539
|
+
"created_by_app": null,
|
|
2540
|
+
"created_at": "2023-02-17T11:43:55Z",
|
|
2541
|
+
"previous_secret_expires_at": null,
|
|
2542
|
+
"secret": "whsec_YOUR_SIGNING_SECRET_HERE"
|
|
2543
|
+
}
|
|
2544
|
+
}
|
|
2545
|
+
}
|
|
2546
|
+
},
|
|
2547
|
+
"webhook_endpoints_update": {
|
|
2548
|
+
"verb": "patch",
|
|
2549
|
+
"path": "/v4/webhook_endpoints/{id}",
|
|
2550
|
+
"key": "webhook_endpoint",
|
|
2551
|
+
"kind": "object",
|
|
2552
|
+
"type": "webhook_endpoint",
|
|
2553
|
+
"responses": {
|
|
2554
|
+
"200": {
|
|
2555
|
+
"webhook_endpoint": {
|
|
2556
|
+
"id": 29,
|
|
2557
|
+
"name": "Updated name",
|
|
2558
|
+
"url": "https://hooks.example.com/v2",
|
|
2559
|
+
"events": [
|
|
2560
|
+
"subscriber.activated"
|
|
2561
|
+
],
|
|
2562
|
+
"status": "active",
|
|
2563
|
+
"source": "creator",
|
|
2564
|
+
"description": "Now with details",
|
|
2565
|
+
"created_by_app": null,
|
|
2566
|
+
"created_at": "2023-02-17T11:43:55Z",
|
|
2567
|
+
"previous_secret_expires_at": null
|
|
2568
|
+
}
|
|
2569
|
+
}
|
|
2570
|
+
}
|
|
2571
|
+
},
|
|
2572
|
+
"webhook_endpoints_delete": {
|
|
2573
|
+
"verb": "delete",
|
|
2574
|
+
"path": "/v4/webhook_endpoints/{id}",
|
|
2575
|
+
"key": null,
|
|
2576
|
+
"kind": "none",
|
|
2577
|
+
"type": null,
|
|
2578
|
+
"responses": {
|
|
2579
|
+
"204": null
|
|
2580
|
+
}
|
|
2581
|
+
},
|
|
2582
|
+
"webhook_endpoints_rotate_secret": {
|
|
2583
|
+
"verb": "post",
|
|
2584
|
+
"path": "/v4/webhook_endpoints/{id}/rotate_secret",
|
|
2585
|
+
"key": "webhook_endpoint",
|
|
2586
|
+
"kind": "object",
|
|
2587
|
+
"type": "webhook_endpoint",
|
|
2588
|
+
"responses": {
|
|
2589
|
+
"200": {
|
|
2590
|
+
"webhook_endpoint": {
|
|
2591
|
+
"id": 66,
|
|
2592
|
+
"name": "My webhook",
|
|
2593
|
+
"url": "https://hooks.example.com/incoming",
|
|
2594
|
+
"events": [
|
|
2595
|
+
"subscriber.created"
|
|
2596
|
+
],
|
|
2597
|
+
"status": "active",
|
|
2598
|
+
"source": "creator",
|
|
2599
|
+
"description": "A test webhook",
|
|
2600
|
+
"created_by_app": null,
|
|
2601
|
+
"created_at": "2023-02-17T11:43:55Z",
|
|
2602
|
+
"previous_secret_expires_at": "2023-02-18T11:43:55Z",
|
|
2603
|
+
"secret": "whsec_YOUR_SIGNING_SECRET_HERE"
|
|
2604
|
+
}
|
|
2605
|
+
}
|
|
2606
|
+
}
|
|
2607
|
+
},
|
|
2608
|
+
"webhook_endpoints_revoke_previous_secret": {
|
|
2609
|
+
"verb": "post",
|
|
2610
|
+
"path": "/v4/webhook_endpoints/{id}/revoke_previous_secret",
|
|
2611
|
+
"key": "webhook_endpoint",
|
|
2612
|
+
"kind": "object",
|
|
2613
|
+
"type": "webhook_endpoint",
|
|
2614
|
+
"responses": {
|
|
2615
|
+
"200": {
|
|
2616
|
+
"webhook_endpoint": {
|
|
2617
|
+
"id": 85,
|
|
2618
|
+
"name": "My webhook",
|
|
2619
|
+
"url": "https://hooks.example.com/incoming",
|
|
2620
|
+
"events": [
|
|
2621
|
+
"subscriber.created"
|
|
2622
|
+
],
|
|
2623
|
+
"status": "active",
|
|
2624
|
+
"source": "creator",
|
|
2625
|
+
"description": "A test webhook",
|
|
2626
|
+
"created_by_app": null,
|
|
2627
|
+
"created_at": "2023-02-17T11:43:55Z",
|
|
2628
|
+
"previous_secret_expires_at": null
|
|
2629
|
+
}
|
|
2630
|
+
}
|
|
2631
|
+
}
|
|
2632
|
+
},
|
|
2633
|
+
"bulk_create_subscribers": {
|
|
2634
|
+
"verb": "post",
|
|
2635
|
+
"path": "/v4/bulk/subscribers",
|
|
2636
|
+
"key": null,
|
|
2637
|
+
"kind": "raw",
|
|
2638
|
+
"type": null,
|
|
2639
|
+
"responses": {
|
|
2640
|
+
"200": {
|
|
2641
|
+
"subscribers": [
|
|
2642
|
+
{
|
|
2643
|
+
"id": 601,
|
|
2644
|
+
"first_name": null,
|
|
2645
|
+
"email_address": "brooke@convertkit.dev",
|
|
2646
|
+
"state": "active",
|
|
2647
|
+
"created_at": "2023-02-17T11:43:55Z"
|
|
2648
|
+
},
|
|
2649
|
+
{
|
|
2650
|
+
"id": 602,
|
|
2651
|
+
"first_name": "Camille",
|
|
2652
|
+
"email_address": "camille@convertkit.dev",
|
|
2653
|
+
"state": "active",
|
|
2654
|
+
"created_at": "2023-02-17T11:43:55Z"
|
|
2655
|
+
},
|
|
2656
|
+
{
|
|
2657
|
+
"id": 600,
|
|
2658
|
+
"first_name": "Alice",
|
|
2659
|
+
"email_address": "alice@convertkit.dev",
|
|
2660
|
+
"state": "active",
|
|
2661
|
+
"created_at": "2023-02-17T11:43:55Z"
|
|
2662
|
+
}
|
|
2663
|
+
],
|
|
2664
|
+
"failures": [
|
|
2665
|
+
{
|
|
2666
|
+
"subscriber": {
|
|
2667
|
+
"first_name": "Benito",
|
|
2668
|
+
"email_address": null,
|
|
2669
|
+
"state": "active",
|
|
2670
|
+
"created_at": null
|
|
2671
|
+
},
|
|
2672
|
+
"errors": [
|
|
2673
|
+
"Email address is invalid"
|
|
2674
|
+
]
|
|
2675
|
+
}
|
|
2676
|
+
]
|
|
2677
|
+
},
|
|
2678
|
+
"202": {}
|
|
2679
|
+
}
|
|
2680
|
+
},
|
|
2681
|
+
"bulk_create_custom_fields": {
|
|
2682
|
+
"verb": "post",
|
|
2683
|
+
"path": "/v4/bulk/custom_fields",
|
|
2684
|
+
"key": null,
|
|
2685
|
+
"kind": "raw",
|
|
2686
|
+
"type": null,
|
|
2687
|
+
"responses": {
|
|
2688
|
+
"200": {
|
|
2689
|
+
"custom_fields": [
|
|
2690
|
+
{
|
|
2691
|
+
"id": 144,
|
|
2692
|
+
"key": "existing_custom_field",
|
|
2693
|
+
"label": "Existing Custom Field",
|
|
2694
|
+
"name": "ck_field_144_existing_custom_field",
|
|
2695
|
+
"created_at": "2023-02-17T11:43:55Z"
|
|
2696
|
+
},
|
|
2697
|
+
{
|
|
2698
|
+
"id": 146,
|
|
2699
|
+
"key": "interests",
|
|
2700
|
+
"label": "Interests",
|
|
2701
|
+
"name": "ck_field_146_interests",
|
|
2702
|
+
"created_at": "2023-02-17T11:43:55Z"
|
|
2703
|
+
},
|
|
2704
|
+
{
|
|
2705
|
+
"id": 145,
|
|
2706
|
+
"key": "last_name",
|
|
2707
|
+
"label": "Last name",
|
|
2708
|
+
"name": "ck_field_145_last_name",
|
|
2709
|
+
"created_at": "2023-02-17T11:43:55Z"
|
|
2710
|
+
}
|
|
2711
|
+
],
|
|
2712
|
+
"failures": []
|
|
2713
|
+
},
|
|
2714
|
+
"202": {}
|
|
2715
|
+
}
|
|
2716
|
+
},
|
|
2717
|
+
"bulk_update_custom_field_values": {
|
|
2718
|
+
"verb": "post",
|
|
2719
|
+
"path": "/v4/bulk/custom_fields/subscribers",
|
|
2720
|
+
"key": null,
|
|
2721
|
+
"kind": "raw",
|
|
2722
|
+
"type": null,
|
|
2723
|
+
"responses": {
|
|
2724
|
+
"200": {
|
|
2725
|
+
"custom_field_values": [
|
|
2726
|
+
{
|
|
2727
|
+
"subscriber_id": 622,
|
|
2728
|
+
"subscriber_custom_field_id": 157,
|
|
2729
|
+
"value": "Smith"
|
|
2730
|
+
},
|
|
2731
|
+
{
|
|
2732
|
+
"subscriber_id": 622,
|
|
2733
|
+
"subscriber_custom_field_id": 158,
|
|
2734
|
+
"value": "Acme Inc"
|
|
2735
|
+
}
|
|
2736
|
+
],
|
|
2737
|
+
"failures": [
|
|
2738
|
+
{
|
|
2739
|
+
"errors": [
|
|
2740
|
+
"Subscriber does not exist"
|
|
2741
|
+
],
|
|
2742
|
+
"custom_field_value": {
|
|
2743
|
+
"subscriber_id": null,
|
|
2744
|
+
"subscriber_custom_field_id": 157,
|
|
2745
|
+
"value": "Jones"
|
|
2746
|
+
}
|
|
2747
|
+
},
|
|
2748
|
+
{
|
|
2749
|
+
"errors": [
|
|
2750
|
+
"Custom field does not exist"
|
|
2751
|
+
],
|
|
2752
|
+
"custom_field_value": {
|
|
2753
|
+
"subscriber_id": 622,
|
|
2754
|
+
"subscriber_custom_field_id": 999999,
|
|
2755
|
+
"value": "Test"
|
|
2756
|
+
}
|
|
2757
|
+
}
|
|
2758
|
+
]
|
|
2759
|
+
},
|
|
2760
|
+
"202": {}
|
|
2761
|
+
}
|
|
2762
|
+
},
|
|
2763
|
+
"bulk_add_subscribers_to_forms": {
|
|
2764
|
+
"verb": "post",
|
|
2765
|
+
"path": "/v4/bulk/forms/subscribers",
|
|
2766
|
+
"key": null,
|
|
2767
|
+
"kind": "raw",
|
|
2768
|
+
"type": null,
|
|
2769
|
+
"responses": {
|
|
2770
|
+
"200": {
|
|
2771
|
+
"subscribers": [
|
|
2772
|
+
{
|
|
2773
|
+
"id": 640,
|
|
2774
|
+
"first_name": "Sub",
|
|
2775
|
+
"email_address": "sub@example.com",
|
|
2776
|
+
"created_at": "2023-02-17T11:43:55Z",
|
|
2777
|
+
"added_at": "2023-02-17T11:43:55Z",
|
|
2778
|
+
"referrer": "https://mywebsite.com/bfpromo/?utm_source=facebook&utm_medium=cpc&utm_campaign=black_friday&utm_term=car_owners&utm_content=get_10_off",
|
|
2779
|
+
"referrer_utm_parameters": {
|
|
2780
|
+
"source": "facebook",
|
|
2781
|
+
"medium": "cpc",
|
|
2782
|
+
"campaign": "black_friday",
|
|
2783
|
+
"term": "car_owners",
|
|
2784
|
+
"content": "get_10_off"
|
|
2785
|
+
}
|
|
2786
|
+
},
|
|
2787
|
+
{
|
|
2788
|
+
"id": 640,
|
|
2789
|
+
"first_name": "Sub",
|
|
2790
|
+
"email_address": "sub@example.com",
|
|
2791
|
+
"created_at": "2023-02-17T11:43:55Z",
|
|
2792
|
+
"added_at": "2023-02-17T11:43:55Z",
|
|
2793
|
+
"referrer": "https://mywebsite.com/bfpromo/?utm_source=facebook&utm_medium=cpc&utm_campaign=black_friday&utm_term=car_owners&utm_content=get_10_off",
|
|
2794
|
+
"referrer_utm_parameters": {
|
|
2795
|
+
"source": "facebook",
|
|
2796
|
+
"medium": "cpc",
|
|
2797
|
+
"campaign": "black_friday",
|
|
2798
|
+
"term": "car_owners",
|
|
2799
|
+
"content": "get_10_off"
|
|
2800
|
+
}
|
|
2801
|
+
}
|
|
2802
|
+
],
|
|
2803
|
+
"failures": [
|
|
2804
|
+
{
|
|
2805
|
+
"errors": [
|
|
2806
|
+
"Subscriber does not exist"
|
|
2807
|
+
],
|
|
2808
|
+
"subscription": {
|
|
2809
|
+
"form_id": 215,
|
|
2810
|
+
"subscriber_id": null,
|
|
2811
|
+
"referrer": "https://mywebsite.com/bfpromo/?utm_source=facebook&utm_medium=cpc&utm_campaign=black_friday&utm_term=car_owners&utm_content=get_10_off"
|
|
2812
|
+
}
|
|
2813
|
+
},
|
|
2814
|
+
{
|
|
2815
|
+
"errors": [
|
|
2816
|
+
"Form does not exist"
|
|
2817
|
+
],
|
|
2818
|
+
"subscription": {
|
|
2819
|
+
"form_id": null,
|
|
2820
|
+
"subscriber_id": 640,
|
|
2821
|
+
"referrer": "https://mywebsite.com/bfpromo/?utm_source=facebook&utm_medium=cpc&utm_campaign=black_friday&utm_term=car_owners&utm_content=get_10_off"
|
|
2822
|
+
}
|
|
2823
|
+
}
|
|
2824
|
+
]
|
|
2825
|
+
},
|
|
2826
|
+
"202": {}
|
|
2827
|
+
}
|
|
2828
|
+
},
|
|
2829
|
+
"bulk_create_tags": {
|
|
2830
|
+
"verb": "post",
|
|
2831
|
+
"path": "/v4/bulk/tags",
|
|
2832
|
+
"key": null,
|
|
2833
|
+
"kind": "raw",
|
|
2834
|
+
"type": null,
|
|
2835
|
+
"responses": {
|
|
2836
|
+
"200": {
|
|
2837
|
+
"tags": [
|
|
2838
|
+
{
|
|
2839
|
+
"id": 74,
|
|
2840
|
+
"name": "Existing Tag",
|
|
2841
|
+
"created_at": "2023-02-17T11:43:55Z"
|
|
2842
|
+
},
|
|
2843
|
+
{
|
|
2844
|
+
"id": 75,
|
|
2845
|
+
"name": "Attended Event",
|
|
2846
|
+
"created_at": "2023-02-17T11:43:55Z"
|
|
2847
|
+
},
|
|
2848
|
+
{
|
|
2849
|
+
"id": 76,
|
|
2850
|
+
"name": "Newsletter",
|
|
2851
|
+
"created_at": "2023-02-17T11:43:55Z"
|
|
2852
|
+
},
|
|
2853
|
+
{
|
|
2854
|
+
"id": 77,
|
|
2855
|
+
"name": "Re-engage",
|
|
2856
|
+
"created_at": "2023-02-17T11:43:55Z"
|
|
2857
|
+
}
|
|
2858
|
+
],
|
|
2859
|
+
"failures": []
|
|
2860
|
+
},
|
|
2861
|
+
"202": {}
|
|
2862
|
+
}
|
|
2863
|
+
},
|
|
2864
|
+
"bulk_delete_tags": {
|
|
2865
|
+
"verb": "delete",
|
|
2866
|
+
"path": "/v4/bulk/tags",
|
|
2867
|
+
"key": null,
|
|
2868
|
+
"kind": "raw",
|
|
2869
|
+
"type": null,
|
|
2870
|
+
"responses": {
|
|
2871
|
+
"200": {
|
|
2872
|
+
"failures": [
|
|
2873
|
+
{
|
|
2874
|
+
"errors": [
|
|
2875
|
+
"Tag does not exist"
|
|
2876
|
+
],
|
|
2877
|
+
"tag": {
|
|
2878
|
+
"id": 92
|
|
2879
|
+
}
|
|
2880
|
+
}
|
|
2881
|
+
]
|
|
2882
|
+
},
|
|
2883
|
+
"202": {}
|
|
2884
|
+
}
|
|
2885
|
+
},
|
|
2886
|
+
"bulk_tag_subscribers": {
|
|
2887
|
+
"verb": "post",
|
|
2888
|
+
"path": "/v4/bulk/tags/subscribers",
|
|
2889
|
+
"key": null,
|
|
2890
|
+
"kind": "raw",
|
|
2891
|
+
"type": null,
|
|
2892
|
+
"responses": {
|
|
2893
|
+
"200": {
|
|
2894
|
+
"subscribers": [
|
|
2895
|
+
{
|
|
2896
|
+
"id": 656,
|
|
2897
|
+
"first_name": "Sub",
|
|
2898
|
+
"email_address": "sub@example.com",
|
|
2899
|
+
"created_at": "2023-02-17T11:43:55Z",
|
|
2900
|
+
"tagged_at": "2023-02-17T11:43:55Z"
|
|
2901
|
+
},
|
|
2902
|
+
{
|
|
2903
|
+
"id": 656,
|
|
2904
|
+
"first_name": "Sub",
|
|
2905
|
+
"email_address": "sub@example.com",
|
|
2906
|
+
"created_at": "2023-02-17T11:43:55Z",
|
|
2907
|
+
"tagged_at": "2023-02-17T11:43:55Z"
|
|
2908
|
+
}
|
|
2909
|
+
],
|
|
2910
|
+
"failures": [
|
|
2911
|
+
{
|
|
2912
|
+
"errors": [
|
|
2913
|
+
"Subscriber does not exist"
|
|
2914
|
+
],
|
|
2915
|
+
"tagging": {
|
|
2916
|
+
"tag_id": 112,
|
|
2917
|
+
"subscriber_id": null
|
|
2918
|
+
}
|
|
2919
|
+
},
|
|
2920
|
+
{
|
|
2921
|
+
"errors": [
|
|
2922
|
+
"Tag does not exist"
|
|
2923
|
+
],
|
|
2924
|
+
"tagging": {
|
|
2925
|
+
"tag_id": null,
|
|
2926
|
+
"subscriber_id": 656
|
|
2927
|
+
}
|
|
2928
|
+
}
|
|
2929
|
+
]
|
|
2930
|
+
},
|
|
2931
|
+
"202": {}
|
|
2932
|
+
}
|
|
2933
|
+
},
|
|
2934
|
+
"bulk_remove_tag_subscribers": {
|
|
2935
|
+
"verb": "delete",
|
|
2936
|
+
"path": "/v4/bulk/tags/subscribers",
|
|
2937
|
+
"key": null,
|
|
2938
|
+
"kind": "raw",
|
|
2939
|
+
"type": null,
|
|
2940
|
+
"responses": {
|
|
2941
|
+
"200": {
|
|
2942
|
+
"failures": []
|
|
2943
|
+
},
|
|
2944
|
+
"202": {}
|
|
2945
|
+
}
|
|
2946
|
+
}
|
|
2947
|
+
}
|