@aloma.io/integration-sdk 3.8.54 → 3.8.55

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.
@@ -1,1889 +0,0 @@
1
- {
2
- "openapi" : "3.0.1",
3
- "info" : {
4
- "title" : "Companies",
5
- "version" : "v3",
6
- "x-hubspot-product-tier-requirements" : {
7
- "marketing" : "FREE",
8
- "sales" : "FREE",
9
- "service" : "FREE",
10
- "cms" : "FREE"
11
- },
12
- "x-hubspot-api-use-case" : "When a new customer signs up on your website with their business email address, create a company record to represent the relationship between the customer and the company they work for. A sales rep can later use this company record for outreach to find other potential sales opportunities. ",
13
- "x-hubspot-related-documentation" : [ {
14
- "name" : "Companies Guide",
15
- "url" : "https://developers.hubspot.com/docs/guides/api/crm/objects/companies"
16
- } ],
17
- "x-hubspot-introduction" : "Use the companies API to create and manage CRM records that represent the companies and organizations that interact with your business."
18
- },
19
- "servers" : [ {
20
- "url" : "https://api.hubapi.com"
21
- } ],
22
- "tags" : [ {
23
- "name" : "Basic"
24
- }, {
25
- "name" : "Public_Object__SE_PT_EM_BE_R_2025"
26
- }, {
27
- "name" : "Search"
28
- }, {
29
- "name" : "Batch"
30
- }, {
31
- "name" : "Public_Object_Search_Post__SE_PT_EM_BE_R_2025"
32
- }, {
33
- "name" : "GDPR"
34
- } ],
35
- "paths" : {
36
- "/crm/v3/objects/companies/batch/read" : {
37
- "post" : {
38
- "tags" : [ "Batch" ],
39
- "summary" : "Retrieve a batch of companies",
40
- "description" : "Retrieve a batch of companies by ID (`companyId`) or by a unique property (`idProperty`). You can specify what is returned using the `properties` query parameter.",
41
- "operationId" : "post-/crm/v3/objects/companies/batch/read_read",
42
- "parameters" : [ {
43
- "name" : "archived",
44
- "in" : "query",
45
- "description" : "Whether to return only results that have been archived.",
46
- "required" : false,
47
- "style" : "form",
48
- "explode" : true,
49
- "schema" : {
50
- "type" : "boolean",
51
- "default" : false
52
- }
53
- } ],
54
- "requestBody" : {
55
- "content" : {
56
- "application/json" : {
57
- "schema" : {
58
- "$ref" : "#/components/schemas/BatchReadInputSimplePublicObjectId"
59
- }
60
- }
61
- },
62
- "required" : true
63
- },
64
- "responses" : {
65
- "200" : {
66
- "description" : "successful operation",
67
- "content" : {
68
- "application/json" : {
69
- "schema" : {
70
- "$ref" : "#/components/schemas/BatchResponseSimplePublicObject"
71
- }
72
- }
73
- }
74
- },
75
- "default" : {
76
- "$ref" : "#/components/responses/Error"
77
- }
78
- },
79
- "security" : [ {
80
- "oauth2_legacy" : [ ]
81
- }, {
82
- "oauth2" : [ "crm.objects.companies.read" ]
83
- }, {
84
- "private_apps_legacy" : [ ]
85
- }, {
86
- "private_apps" : [ "crm.objects.companies.read" ]
87
- } ]
88
- }
89
- },
90
- "/crm/v3/objects/companies" : {
91
- "get" : {
92
- "tags" : [ "Basic" ],
93
- "summary" : "Retrieve companies",
94
- "description" : "Retrieve all companies, using query parameters to control the information that gets returned.",
95
- "operationId" : "get-/crm/v3/objects/companies_getPage",
96
- "parameters" : [ {
97
- "name" : "limit",
98
- "in" : "query",
99
- "description" : "The maximum number of results to display per page.",
100
- "required" : false,
101
- "style" : "form",
102
- "explode" : true,
103
- "schema" : {
104
- "type" : "integer",
105
- "format" : "int32",
106
- "default" : 10
107
- }
108
- }, {
109
- "name" : "after",
110
- "in" : "query",
111
- "description" : "The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.",
112
- "required" : false,
113
- "style" : "form",
114
- "explode" : true,
115
- "schema" : {
116
- "type" : "string"
117
- }
118
- }, {
119
- "name" : "properties",
120
- "in" : "query",
121
- "description" : "A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.",
122
- "required" : false,
123
- "style" : "form",
124
- "explode" : true,
125
- "schema" : {
126
- "type" : "array",
127
- "items" : {
128
- "type" : "string"
129
- }
130
- }
131
- }, {
132
- "name" : "propertiesWithHistory",
133
- "in" : "query",
134
- "description" : "A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of companies that can be read by a single request.",
135
- "required" : false,
136
- "style" : "form",
137
- "explode" : true,
138
- "schema" : {
139
- "type" : "array",
140
- "items" : {
141
- "type" : "string"
142
- }
143
- }
144
- }, {
145
- "name" : "associations",
146
- "in" : "query",
147
- "description" : "A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.",
148
- "required" : false,
149
- "style" : "form",
150
- "explode" : true,
151
- "schema" : {
152
- "type" : "array",
153
- "items" : {
154
- "type" : "string"
155
- }
156
- }
157
- }, {
158
- "name" : "archived",
159
- "in" : "query",
160
- "description" : "Whether to return only results that have been archived.",
161
- "required" : false,
162
- "style" : "form",
163
- "explode" : true,
164
- "schema" : {
165
- "type" : "boolean",
166
- "default" : false
167
- }
168
- } ],
169
- "responses" : {
170
- "200" : {
171
- "description" : "successful operation",
172
- "content" : {
173
- "application/json" : {
174
- "schema" : {
175
- "$ref" : "#/components/schemas/CollectionResponseSimplePublicObjectWithAssociations"
176
- }
177
- }
178
- }
179
- },
180
- "default" : {
181
- "$ref" : "#/components/responses/Error"
182
- }
183
- },
184
- "security" : [ {
185
- "oauth2_legacy" : [ ]
186
- }, {
187
- "oauth2" : [ "crm.objects.companies.read" ]
188
- }, {
189
- "private_apps_legacy" : [ ]
190
- }, {
191
- "private_apps" : [ "crm.objects.companies.read" ]
192
- } ]
193
- },
194
- "post" : {
195
- "tags" : [ "Basic" ],
196
- "summary" : "Create a company",
197
- "description" : "Create a single company. Include a `properties` object to define [property values](https://developers.hubspot.com/docs/guides/api/crm/properties) for the company, along with an `associations` array to define [associations](https://developers.hubspot.com/docs/guides/api/crm/associations/associations-v4) with other CRM records.",
198
- "operationId" : "post-/crm/v3/objects/companies_create",
199
- "parameters" : [ ],
200
- "requestBody" : {
201
- "content" : {
202
- "application/json" : {
203
- "schema" : {
204
- "$ref" : "#/components/schemas/SimplePublicObjectInputForCreate"
205
- }
206
- }
207
- },
208
- "required" : true
209
- },
210
- "responses" : {
211
- "200" : {
212
- "description" : "successful operation",
213
- "content" : {
214
- "application/json" : {
215
- "schema" : {
216
- "$ref" : "#/components/schemas/CreatedResponseSimplePublicObject"
217
- }
218
- }
219
- }
220
- },
221
- "default" : {
222
- "$ref" : "#/components/responses/Error"
223
- }
224
- },
225
- "security" : [ {
226
- "oauth2_legacy" : [ ]
227
- }, {
228
- "oauth2" : [ "crm.objects.companies.write" ]
229
- }, {
230
- "private_apps_legacy" : [ ]
231
- }, {
232
- "private_apps" : [ "crm.objects.companies.write" ]
233
- } ]
234
- }
235
- },
236
- "/crm/v3/objects/companies/search" : {
237
- "post" : {
238
- "tags" : [ "Search" ],
239
- "summary" : "Search for companies",
240
- "description" : "Search for companies by filtering on properties, searching through associations, and sorting results. Learn more about [CRM search](https://developers.hubspot.com/docs/guides/api/crm/search#make-a-search-request).",
241
- "operationId" : "post-/crm/v3/objects/companies/search_doSearch",
242
- "parameters" : [ ],
243
- "requestBody" : {
244
- "content" : {
245
- "application/json" : {
246
- "schema" : {
247
- "$ref" : "#/components/schemas/PublicObjectSearchRequest"
248
- }
249
- }
250
- },
251
- "required" : true
252
- },
253
- "responses" : {
254
- "200" : {
255
- "description" : "successful operation",
256
- "content" : {
257
- "application/json" : {
258
- "schema" : {
259
- "$ref" : "#/components/schemas/CollectionResponseWithTotalSimplePublicObject"
260
- }
261
- }
262
- }
263
- },
264
- "default" : {
265
- "$ref" : "#/components/responses/Error"
266
- }
267
- },
268
- "security" : [ {
269
- "oauth2_legacy" : [ ]
270
- }, {
271
- "oauth2" : [ "crm.objects.companies.read" ]
272
- }, {
273
- "private_apps_legacy" : [ ]
274
- }, {
275
- "private_apps" : [ "crm.objects.companies.read" ]
276
- } ],
277
- "x-hubspot-rate-limit-exemptions" : [ "ten-secondly" ]
278
- }
279
- },
280
- "/crm/v3/objects/companies/{companyId}" : {
281
- "get" : {
282
- "tags" : [ "Basic" ],
283
- "summary" : "Retrieve a company",
284
- "description" : "Retrieve a company by its ID (`companyId`) or by a unique property (`idProperty`). You can specify what is returned using the `properties` query parameter.",
285
- "operationId" : "get-/crm/v3/objects/companies/{companyId}_getById",
286
- "parameters" : [ {
287
- "name" : "companyId",
288
- "in" : "path",
289
- "description" : "The ID of the company",
290
- "required" : true,
291
- "style" : "simple",
292
- "explode" : false,
293
- "schema" : {
294
- "type" : "string"
295
- }
296
- }, {
297
- "name" : "properties",
298
- "in" : "query",
299
- "description" : "A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.",
300
- "required" : false,
301
- "style" : "form",
302
- "explode" : true,
303
- "schema" : {
304
- "type" : "array",
305
- "items" : {
306
- "type" : "string"
307
- }
308
- }
309
- }, {
310
- "name" : "propertiesWithHistory",
311
- "in" : "query",
312
- "description" : "A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.",
313
- "required" : false,
314
- "style" : "form",
315
- "explode" : true,
316
- "schema" : {
317
- "type" : "array",
318
- "items" : {
319
- "type" : "string"
320
- }
321
- }
322
- }, {
323
- "name" : "associations",
324
- "in" : "query",
325
- "description" : "A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.",
326
- "required" : false,
327
- "style" : "form",
328
- "explode" : true,
329
- "schema" : {
330
- "type" : "array",
331
- "items" : {
332
- "type" : "string"
333
- }
334
- }
335
- }, {
336
- "name" : "archived",
337
- "in" : "query",
338
- "description" : "Whether to return only results that have been archived.",
339
- "required" : false,
340
- "style" : "form",
341
- "explode" : true,
342
- "schema" : {
343
- "type" : "boolean",
344
- "default" : false
345
- }
346
- }, {
347
- "name" : "idProperty",
348
- "in" : "query",
349
- "description" : "The name of a property whose values are unique for this object",
350
- "required" : false,
351
- "style" : "form",
352
- "explode" : true,
353
- "schema" : {
354
- "type" : "string"
355
- }
356
- } ],
357
- "responses" : {
358
- "200" : {
359
- "description" : "successful operation",
360
- "content" : {
361
- "application/json" : {
362
- "schema" : {
363
- "$ref" : "#/components/schemas/SimplePublicObjectWithAssociations"
364
- }
365
- }
366
- }
367
- },
368
- "default" : {
369
- "$ref" : "#/components/responses/Error"
370
- }
371
- },
372
- "security" : [ {
373
- "oauth2_legacy" : [ ]
374
- }, {
375
- "oauth2" : [ "crm.objects.companies.read" ]
376
- }, {
377
- "private_apps_legacy" : [ ]
378
- }, {
379
- "private_apps" : [ "crm.objects.companies.read" ]
380
- } ]
381
- },
382
- "delete" : {
383
- "tags" : [ "Basic" ],
384
- "summary" : "Archive a company",
385
- "description" : "Delete a company by ID. Deleted companies can be restored within 90 days of deletion. Learn more about [restoring records](https://knowledge.hubspot.com/records/restore-deleted-records).",
386
- "operationId" : "delete-/crm/v3/objects/companies/{companyId}_archive",
387
- "parameters" : [ {
388
- "name" : "companyId",
389
- "in" : "path",
390
- "required" : true,
391
- "style" : "simple",
392
- "explode" : false,
393
- "schema" : {
394
- "type" : "string"
395
- }
396
- } ],
397
- "responses" : {
398
- "204" : {
399
- "description" : "No content",
400
- "content" : { }
401
- },
402
- "default" : {
403
- "$ref" : "#/components/responses/Error"
404
- }
405
- },
406
- "security" : [ {
407
- "oauth2_legacy" : [ ]
408
- }, {
409
- "oauth2" : [ "crm.objects.companies.write" ]
410
- }, {
411
- "private_apps_legacy" : [ ]
412
- }, {
413
- "private_apps" : [ "crm.objects.companies.write" ]
414
- } ]
415
- },
416
- "patch" : {
417
- "tags" : [ "Basic" ],
418
- "summary" : "Update a company",
419
- "description" : "Update a company by ID (`companyId`) or unique property value (`idProperty`). Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.",
420
- "operationId" : "patch-/crm/v3/objects/companies/{companyId}_update",
421
- "parameters" : [ {
422
- "name" : "companyId",
423
- "in" : "path",
424
- "required" : true,
425
- "style" : "simple",
426
- "explode" : false,
427
- "schema" : {
428
- "type" : "string"
429
- }
430
- }, {
431
- "name" : "idProperty",
432
- "in" : "query",
433
- "description" : "The name of a property whose values are unique for this object",
434
- "required" : false,
435
- "style" : "form",
436
- "explode" : true,
437
- "schema" : {
438
- "type" : "string"
439
- }
440
- } ],
441
- "requestBody" : {
442
- "content" : {
443
- "application/json" : {
444
- "schema" : {
445
- "$ref" : "#/components/schemas/SimplePublicObjectInput"
446
- }
447
- }
448
- },
449
- "required" : true
450
- },
451
- "responses" : {
452
- "200" : {
453
- "description" : "successful operation",
454
- "content" : {
455
- "application/json" : {
456
- "schema" : {
457
- "$ref" : "#/components/schemas/SimplePublicObject"
458
- }
459
- }
460
- }
461
- },
462
- "default" : {
463
- "$ref" : "#/components/responses/Error"
464
- }
465
- },
466
- "security" : [ {
467
- "oauth2_legacy" : [ ]
468
- }, {
469
- "oauth2" : [ "crm.objects.companies.write" ]
470
- }, {
471
- "private_apps_legacy" : [ ]
472
- }, {
473
- "private_apps" : [ "crm.objects.companies.write" ]
474
- } ]
475
- }
476
- },
477
- "/crm/v3/objects/companies/batch/upsert" : {
478
- "post" : {
479
- "tags" : [ "Batch" ],
480
- "summary" : "Create or update a batch of companies by unique property values",
481
- "description" : "Create or update companies identified by a unique property value as specified by the `idProperty` query parameter. `idProperty` query param refers to a property whose values are unique for the object.",
482
- "operationId" : "post-/crm/v3/objects/companies/batch/upsert_upsert",
483
- "parameters" : [ ],
484
- "requestBody" : {
485
- "content" : {
486
- "application/json" : {
487
- "schema" : {
488
- "$ref" : "#/components/schemas/BatchInputSimplePublicObjectBatchInputUpsert"
489
- }
490
- }
491
- },
492
- "required" : true
493
- },
494
- "responses" : {
495
- "200" : {
496
- "description" : "successful operation",
497
- "content" : {
498
- "application/json" : {
499
- "schema" : {
500
- "$ref" : "#/components/schemas/BatchResponseSimplePublicUpsertObject"
501
- }
502
- }
503
- }
504
- },
505
- "default" : {
506
- "$ref" : "#/components/responses/Error"
507
- }
508
- },
509
- "security" : [ {
510
- "oauth2_legacy" : [ ]
511
- }, {
512
- "oauth2" : [ "crm.objects.companies.write" ]
513
- }, {
514
- "private_apps_legacy" : [ ]
515
- }, {
516
- "private_apps" : [ "crm.objects.companies.write" ]
517
- } ]
518
- }
519
- },
520
- "/crm/v3/objects/companies/batch/create" : {
521
- "post" : {
522
- "tags" : [ "Batch" ],
523
- "summary" : "Create a batch of companies",
524
- "description" : "Create a batch of companies. The `inputs` array can contain a `properties` object to define property values for each company, along with an `associations` array to define [associations](https://developers.hubspot.com/docs/guides/api/crm/associations/associations-v4) with other CRM records.",
525
- "operationId" : "post-/crm/v3/objects/companies/batch/create_create",
526
- "parameters" : [ ],
527
- "requestBody" : {
528
- "content" : {
529
- "application/json" : {
530
- "schema" : {
531
- "$ref" : "#/components/schemas/BatchInputSimplePublicObjectBatchInputForCreate"
532
- }
533
- }
534
- },
535
- "required" : true
536
- },
537
- "responses" : {
538
- "200" : {
539
- "description" : "successful operation",
540
- "content" : {
541
- "application/json" : {
542
- "schema" : {
543
- "$ref" : "#/components/schemas/BatchResponseSimplePublicObject"
544
- }
545
- }
546
- }
547
- },
548
- "default" : {
549
- "$ref" : "#/components/responses/Error"
550
- }
551
- },
552
- "security" : [ {
553
- "oauth2_legacy" : [ ]
554
- }, {
555
- "oauth2" : [ "crm.objects.companies.write" ]
556
- }, {
557
- "private_apps_legacy" : [ ]
558
- }, {
559
- "private_apps" : [ "crm.objects.companies.write" ]
560
- } ]
561
- }
562
- },
563
- "/crm/v3/objects/companies/batch/update" : {
564
- "post" : {
565
- "tags" : [ "Batch" ],
566
- "summary" : "Update a batch of companies",
567
- "description" : "Update a batch of companies by ID.",
568
- "operationId" : "post-/crm/v3/objects/companies/batch/update_update",
569
- "parameters" : [ ],
570
- "requestBody" : {
571
- "content" : {
572
- "application/json" : {
573
- "schema" : {
574
- "$ref" : "#/components/schemas/BatchInputSimplePublicObjectBatchInput"
575
- }
576
- }
577
- },
578
- "required" : true
579
- },
580
- "responses" : {
581
- "200" : {
582
- "description" : "successful operation",
583
- "content" : {
584
- "application/json" : {
585
- "schema" : {
586
- "$ref" : "#/components/schemas/BatchResponseSimplePublicObject"
587
- }
588
- }
589
- }
590
- },
591
- "default" : {
592
- "$ref" : "#/components/responses/Error"
593
- }
594
- },
595
- "security" : [ {
596
- "oauth2_legacy" : [ ]
597
- }, {
598
- "oauth2" : [ "crm.objects.companies.write" ]
599
- }, {
600
- "private_apps_legacy" : [ ]
601
- }, {
602
- "private_apps" : [ "crm.objects.companies.write" ]
603
- } ]
604
- }
605
- },
606
- "/crm/v3/objects/companies/batch/archive" : {
607
- "post" : {
608
- "tags" : [ "Batch" ],
609
- "summary" : "Archive a batch of companies",
610
- "description" : "Delete a batch of companies by ID. Deleted companies can be restored within 90 days of deletion. Learn more about [restoring records](https://knowledge.hubspot.com/records/restore-deleted-records).",
611
- "operationId" : "post-/crm/v3/objects/companies/batch/archive_archive",
612
- "parameters" : [ ],
613
- "requestBody" : {
614
- "content" : {
615
- "application/json" : {
616
- "schema" : {
617
- "$ref" : "#/components/schemas/BatchInputSimplePublicObjectId"
618
- }
619
- }
620
- },
621
- "required" : true
622
- },
623
- "responses" : {
624
- "204" : {
625
- "description" : "No content",
626
- "content" : { }
627
- },
628
- "default" : {
629
- "$ref" : "#/components/responses/Error"
630
- }
631
- },
632
- "security" : [ {
633
- "oauth2_legacy" : [ ]
634
- }, {
635
- "oauth2" : [ "crm.objects.companies.write" ]
636
- }, {
637
- "private_apps_legacy" : [ ]
638
- }, {
639
- "private_apps" : [ "crm.objects.companies.write" ]
640
- } ]
641
- }
642
- },
643
- "/crm/v3/objects/companies/merge" : {
644
- "post" : {
645
- "tags" : [ "Basic" ],
646
- "summary" : "Merge two companies",
647
- "description" : "Merge two company records. Learn more about [merging records](https://knowledge.hubspot.com/records/merge-records).",
648
- "operationId" : "post-/crm/v3/objects/companies/merge_merge",
649
- "parameters" : [ ],
650
- "requestBody" : {
651
- "content" : {
652
- "application/json" : {
653
- "schema" : {
654
- "$ref" : "#/components/schemas/PublicMergeInput"
655
- }
656
- }
657
- },
658
- "required" : true
659
- },
660
- "responses" : {
661
- "200" : {
662
- "description" : "successful operation",
663
- "content" : {
664
- "application/json" : {
665
- "schema" : {
666
- "$ref" : "#/components/schemas/SimplePublicObject"
667
- }
668
- }
669
- }
670
- },
671
- "default" : {
672
- "$ref" : "#/components/responses/Error"
673
- }
674
- },
675
- "security" : [ {
676
- "oauth2_legacy" : [ ]
677
- }, {
678
- "oauth2" : [ "crm.objects.companies.write" ]
679
- }, {
680
- "private_apps_legacy" : [ ]
681
- }, {
682
- "private_apps" : [ "crm.objects.companies.write" ]
683
- } ]
684
- }
685
- }
686
- },
687
- "components" : {
688
- "schemas" : {
689
- "CreatedResponseSimplePublicObject" : {
690
- "required" : [ "createdResourceId", "entity" ],
691
- "type" : "object",
692
- "properties" : {
693
- "location" : {
694
- "type" : "string"
695
- },
696
- "createdResourceId" : {
697
- "type" : "string"
698
- },
699
- "entity" : {
700
- "$ref" : "#/components/schemas/SimplePublicObject"
701
- }
702
- }
703
- },
704
- "StandardError" : {
705
- "required" : [ "category", "context", "errors", "links", "message", "status" ],
706
- "type" : "object",
707
- "properties" : {
708
- "subCategory" : {
709
- "type" : "object",
710
- "properties" : { },
711
- "description" : "A more specific error category within each main category."
712
- },
713
- "context" : {
714
- "type" : "object",
715
- "additionalProperties" : {
716
- "type" : "array",
717
- "items" : {
718
- "type" : "string"
719
- }
720
- },
721
- "description" : "Additional context-specific information related to the error."
722
- },
723
- "links" : {
724
- "type" : "object",
725
- "additionalProperties" : {
726
- "type" : "string"
727
- },
728
- "description" : "URLs linking to documentation or resources associated with the error."
729
- },
730
- "id" : {
731
- "type" : "string",
732
- "description" : "A unique ID for the error instance."
733
- },
734
- "category" : {
735
- "type" : "string",
736
- "description" : "The main category of the error."
737
- },
738
- "message" : {
739
- "type" : "string",
740
- "description" : "A human-readable string describing the error and possible remediation steps."
741
- },
742
- "errors" : {
743
- "type" : "array",
744
- "description" : "The detailed error objects.",
745
- "items" : {
746
- "$ref" : "#/components/schemas/ErrorDetail"
747
- }
748
- },
749
- "status" : {
750
- "type" : "string",
751
- "description" : "The HTTP status code associated with the error."
752
- }
753
- },
754
- "description" : "Ye olde error"
755
- },
756
- "CollectionResponseAssociatedId" : {
757
- "required" : [ "results" ],
758
- "type" : "object",
759
- "properties" : {
760
- "paging" : {
761
- "$ref" : "#/components/schemas/Paging"
762
- },
763
- "results" : {
764
- "type" : "array",
765
- "items" : {
766
- "$ref" : "#/components/schemas/AssociatedId"
767
- }
768
- }
769
- }
770
- },
771
- "CollectionResponseWithTotalSimplePublicObject" : {
772
- "required" : [ "results", "total" ],
773
- "type" : "object",
774
- "properties" : {
775
- "total" : {
776
- "type" : "integer",
777
- "description" : "The number of available results",
778
- "format" : "int32"
779
- },
780
- "results" : {
781
- "type" : "array",
782
- "items" : {
783
- "$ref" : "#/components/schemas/SimplePublicObject"
784
- }
785
- },
786
- "paging" : {
787
- "$ref" : "#/components/schemas/Paging"
788
- }
789
- }
790
- },
791
- "LabelsBetweenObjectPair" : {
792
- "required" : [ "fromObjectId", "fromObjectTypeId", "labels", "toObjectId", "toObjectTypeId" ],
793
- "type" : "object",
794
- "properties" : {
795
- "fromObjectTypeId" : {
796
- "type" : "string"
797
- },
798
- "fromObjectId" : {
799
- "type" : "string"
800
- },
801
- "toObjectTypeId" : {
802
- "type" : "string"
803
- },
804
- "toObjectId" : {
805
- "type" : "string"
806
- },
807
- "labels" : {
808
- "type" : "array",
809
- "items" : {
810
- "type" : "string"
811
- }
812
- }
813
- }
814
- },
815
- "PublicAssociationsForObject" : {
816
- "required" : [ "to", "types" ],
817
- "type" : "object",
818
- "properties" : {
819
- "types" : {
820
- "type" : "array",
821
- "items" : {
822
- "$ref" : "#/components/schemas/AssociationSpec"
823
- }
824
- },
825
- "to" : {
826
- "$ref" : "#/components/schemas/PublicObjectId"
827
- }
828
- }
829
- },
830
- "BatchResponseSimplePublicObject" : {
831
- "required" : [ "completedAt", "results", "startedAt", "status" ],
832
- "type" : "object",
833
- "properties" : {
834
- "completedAt" : {
835
- "type" : "string",
836
- "description" : "The timestamp when the batch processing was completed, in ISO 8601 format.",
837
- "format" : "date-time"
838
- },
839
- "numErrors" : {
840
- "type" : "integer",
841
- "format" : "int32"
842
- },
843
- "requestedAt" : {
844
- "type" : "string",
845
- "description" : "The timestamp when the batch request was initially made, in ISO 8601 format.",
846
- "format" : "date-time"
847
- },
848
- "startedAt" : {
849
- "type" : "string",
850
- "description" : "The timestamp when the batch processing began, in ISO 8601 format.",
851
- "format" : "date-time"
852
- },
853
- "links" : {
854
- "type" : "object",
855
- "additionalProperties" : {
856
- "type" : "string"
857
- },
858
- "description" : "An object containing relevant links related to the batch request."
859
- },
860
- "results" : {
861
- "type" : "array",
862
- "items" : {
863
- "$ref" : "#/components/schemas/SimplePublicObject"
864
- }
865
- },
866
- "errors" : {
867
- "type" : "array",
868
- "items" : {
869
- "$ref" : "#/components/schemas/StandardError"
870
- }
871
- },
872
- "status" : {
873
- "type" : "string",
874
- "description" : "The status of the batch processing request: \"PENDING\", \"PROCESSING\", \"CANCELLED\", or \"COMPLETE\"",
875
- "enum" : [ "PENDING", "PROCESSING", "CANCELED", "COMPLETE" ]
876
- }
877
- },
878
- "description" : "A public object batch response object"
879
- },
880
- "FilterGroup" : {
881
- "required" : [ "filters" ],
882
- "type" : "object",
883
- "properties" : {
884
- "filters" : {
885
- "type" : "array",
886
- "items" : {
887
- "$ref" : "#/components/schemas/Filter"
888
- }
889
- }
890
- }
891
- },
892
- "MultiAssociatedObjectWithLabel" : {
893
- "required" : [ "associationTypes", "toObjectId" ],
894
- "type" : "object",
895
- "properties" : {
896
- "toObjectId" : {
897
- "type" : "string"
898
- },
899
- "associationTypes" : {
900
- "type" : "array",
901
- "items" : {
902
- "$ref" : "#/components/schemas/AssociationSpecWithLabel"
903
- }
904
- }
905
- }
906
- },
907
- "ErrorDetail" : {
908
- "required" : [ "message" ],
909
- "type" : "object",
910
- "properties" : {
911
- "subCategory" : {
912
- "type" : "string",
913
- "description" : "A specific category that contains more specific detail about the error"
914
- },
915
- "code" : {
916
- "type" : "string",
917
- "description" : "The status code associated with the error detail"
918
- },
919
- "in" : {
920
- "type" : "string",
921
- "description" : "The name of the field or parameter in which the error was found."
922
- },
923
- "context" : {
924
- "type" : "object",
925
- "additionalProperties" : {
926
- "type" : "array",
927
- "items" : {
928
- "type" : "string"
929
- }
930
- },
931
- "description" : "Context about the error condition",
932
- "example" : "{\"missingScopes\":[\"scope1\",\"scope2\"]}"
933
- },
934
- "message" : {
935
- "type" : "string",
936
- "description" : "A human readable message describing the error along with remediation steps where appropriate"
937
- }
938
- }
939
- },
940
- "SimplePublicObjectId" : {
941
- "required" : [ "id" ],
942
- "type" : "object",
943
- "properties" : {
944
- "id" : {
945
- "type" : "string"
946
- }
947
- }
948
- },
949
- "AssociationSpecWithLabel" : {
950
- "required" : [ "category", "typeId" ],
951
- "type" : "object",
952
- "properties" : {
953
- "category" : {
954
- "type" : "string",
955
- "enum" : [ "HUBSPOT_DEFINED", "USER_DEFINED", "INTEGRATOR_DEFINED" ]
956
- },
957
- "typeId" : {
958
- "type" : "integer",
959
- "format" : "int32"
960
- },
961
- "label" : {
962
- "type" : "string"
963
- }
964
- }
965
- },
966
- "CreatedResponseLabelsBetweenObjectPair" : {
967
- "required" : [ "createdResourceId", "entity" ],
968
- "type" : "object",
969
- "properties" : {
970
- "location" : {
971
- "type" : "string"
972
- },
973
- "createdResourceId" : {
974
- "type" : "string"
975
- },
976
- "entity" : {
977
- "$ref" : "#/components/schemas/LabelsBetweenObjectPair"
978
- }
979
- }
980
- },
981
- "BatchReadInputSimplePublicObjectId" : {
982
- "required" : [ "inputs", "properties", "propertiesWithHistory" ],
983
- "type" : "object",
984
- "properties" : {
985
- "propertiesWithHistory" : {
986
- "type" : "array",
987
- "description" : "Key-value pairs for setting properties for the new object and their histories.",
988
- "items" : {
989
- "type" : "string"
990
- }
991
- },
992
- "idProperty" : {
993
- "type" : "string",
994
- "description" : "When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID."
995
- },
996
- "inputs" : {
997
- "type" : "array",
998
- "items" : {
999
- "$ref" : "#/components/schemas/SimplePublicObjectId"
1000
- }
1001
- },
1002
- "properties" : {
1003
- "type" : "array",
1004
- "description" : "Key-value pairs for setting properties for the new object.",
1005
- "items" : {
1006
- "type" : "string"
1007
- }
1008
- }
1009
- },
1010
- "description" : "Specifies the input for reading a batch of CRM objects, including arrays of object IDs, requested property names (with optional history), and an optional unique identifying property."
1011
- },
1012
- "BatchResponseSimplePublicUpsertObject" : {
1013
- "required" : [ "completedAt", "results", "startedAt", "status" ],
1014
- "type" : "object",
1015
- "properties" : {
1016
- "completedAt" : {
1017
- "type" : "string",
1018
- "description" : "The timestamp when the batch process was completed, in ISO 8601 format.",
1019
- "format" : "date-time"
1020
- },
1021
- "numErrors" : {
1022
- "type" : "integer",
1023
- "format" : "int32"
1024
- },
1025
- "requestedAt" : {
1026
- "type" : "string",
1027
- "description" : "The timestamp when the batch process was initiated, in ISO 8601 format.",
1028
- "format" : "date-time"
1029
- },
1030
- "startedAt" : {
1031
- "type" : "string",
1032
- "description" : "The timestamp when the batch process began execution, in ISO 8601 format.",
1033
- "format" : "date-time"
1034
- },
1035
- "links" : {
1036
- "type" : "object",
1037
- "additionalProperties" : {
1038
- "type" : "string"
1039
- },
1040
- "description" : "An object containing relevant links related to the batch request."
1041
- },
1042
- "results" : {
1043
- "type" : "array",
1044
- "items" : {
1045
- "$ref" : "#/components/schemas/SimplePublicUpsertObject"
1046
- }
1047
- },
1048
- "errors" : {
1049
- "type" : "array",
1050
- "items" : {
1051
- "$ref" : "#/components/schemas/StandardError"
1052
- }
1053
- },
1054
- "status" : {
1055
- "type" : "string",
1056
- "description" : "The status of the batch processing request. Can be: \"PENDING\", \"PROCESSING\", \"CANCELED\", or \"COMPLETE\".",
1057
- "enum" : [ "PENDING", "PROCESSING", "CANCELED", "COMPLETE" ]
1058
- }
1059
- },
1060
- "description" : "Represents the result of a batch upsert operation, including the operation’s status, timestamps, and a list of successfully created or updated objects."
1061
- },
1062
- "BatchInputSimplePublicObjectId" : {
1063
- "required" : [ "inputs" ],
1064
- "type" : "object",
1065
- "properties" : {
1066
- "inputs" : {
1067
- "type" : "array",
1068
- "items" : {
1069
- "$ref" : "#/components/schemas/SimplePublicObjectId"
1070
- }
1071
- }
1072
- }
1073
- },
1074
- "ValueWithTimestamp" : {
1075
- "required" : [ "sourceType", "timestamp", "value" ],
1076
- "type" : "object",
1077
- "properties" : {
1078
- "sourceId" : {
1079
- "type" : "string",
1080
- "description" : "The unique ID of the property."
1081
- },
1082
- "sourceType" : {
1083
- "type" : "string",
1084
- "description" : "The property type."
1085
- },
1086
- "sourceLabel" : {
1087
- "type" : "string",
1088
- "description" : "A human-readable label."
1089
- },
1090
- "updatedByUserId" : {
1091
- "type" : "integer",
1092
- "description" : "The ID of the user who last updated the property.",
1093
- "format" : "int32"
1094
- },
1095
- "value" : {
1096
- "type" : "string",
1097
- "description" : "The property value."
1098
- },
1099
- "timestamp" : {
1100
- "type" : "string",
1101
- "description" : "The timestamp when the property was updated, in ISO 8601 format.",
1102
- "format" : "date-time"
1103
- }
1104
- },
1105
- "description" : "Property model that includes timestamp."
1106
- },
1107
- "BatchInputSimplePublicObjectBatchInputUpsert" : {
1108
- "required" : [ "inputs" ],
1109
- "type" : "object",
1110
- "properties" : {
1111
- "inputs" : {
1112
- "type" : "array",
1113
- "items" : {
1114
- "$ref" : "#/components/schemas/SimplePublicObjectBatchInputUpsert"
1115
- }
1116
- }
1117
- }
1118
- },
1119
- "SimplePublicObject" : {
1120
- "required" : [ "createdAt", "id", "properties", "updatedAt" ],
1121
- "type" : "object",
1122
- "properties" : {
1123
- "createdAt" : {
1124
- "type" : "string",
1125
- "description" : "The timestamp when the object was created, in ISO 8601 format.",
1126
- "format" : "date-time"
1127
- },
1128
- "archived" : {
1129
- "type" : "boolean",
1130
- "description" : "Whether the object is archived."
1131
- },
1132
- "archivedAt" : {
1133
- "type" : "string",
1134
- "description" : "The timestamp when the object was archived, in ISO 8601 format.",
1135
- "format" : "date-time"
1136
- },
1137
- "propertiesWithHistory" : {
1138
- "type" : "object",
1139
- "additionalProperties" : {
1140
- "type" : "array",
1141
- "items" : {
1142
- "$ref" : "#/components/schemas/ValueWithTimestamp"
1143
- }
1144
- },
1145
- "description" : "Key-value pairs representing the properties of the object along with their history."
1146
- },
1147
- "id" : {
1148
- "type" : "string",
1149
- "description" : "The unique ID of the object.",
1150
- "example" : "512"
1151
- },
1152
- "objectWriteTraceId" : {
1153
- "type" : "string"
1154
- },
1155
- "properties" : {
1156
- "type" : "object",
1157
- "additionalProperties" : {
1158
- "type" : "string",
1159
- "nullable" : true
1160
- },
1161
- "description" : "Key-value pairs representing the properties of the object.",
1162
- "example" : "{\"property_date\":\"1572480000000\",\"property_radio\":\"option_1\",\"property_number\":\"17\",\"property_string\":\"value\",\"property_checkbox\":\"false\",\"property_dropdown\":\"choice_b\",\"property_multiple_checkboxes\":\"chocolate;strawberry\"}"
1163
- },
1164
- "updatedAt" : {
1165
- "type" : "string",
1166
- "description" : "The timestamp when the object was last updated, in ISO 8601 format.",
1167
- "format" : "date-time"
1168
- }
1169
- },
1170
- "description" : "A simple public object.",
1171
- "example" : {
1172
- "archived" : false,
1173
- "createdAt" : "2019-10-30T03:30:17.883Z",
1174
- "id" : "512",
1175
- "properties" : {
1176
- "property_checkbox" : "false",
1177
- "property_date" : "1572480000000",
1178
- "property_dropdown" : "choice_b",
1179
- "property_multiple_checkboxes" : "chocolate;strawberry",
1180
- "property_number" : "17",
1181
- "property_radio" : "option_1",
1182
- "property_string" : "value"
1183
- },
1184
- "updatedAt" : "2019-12-07T16:50:06.678Z"
1185
- }
1186
- },
1187
- "PublicObjectId" : {
1188
- "required" : [ "id" ],
1189
- "type" : "object",
1190
- "properties" : {
1191
- "id" : {
1192
- "type" : "string",
1193
- "description" : "The ID of the target record to associate."
1194
- }
1195
- }
1196
- },
1197
- "Paging" : {
1198
- "type" : "object",
1199
- "properties" : {
1200
- "next" : {
1201
- "$ref" : "#/components/schemas/NextPage"
1202
- },
1203
- "prev" : {
1204
- "$ref" : "#/components/schemas/PreviousPage"
1205
- }
1206
- }
1207
- },
1208
- "CollectionResponseMultiAssociatedObjectWithLabel" : {
1209
- "required" : [ "results" ],
1210
- "type" : "object",
1211
- "properties" : {
1212
- "results" : {
1213
- "type" : "array",
1214
- "items" : {
1215
- "$ref" : "#/components/schemas/MultiAssociatedObjectWithLabel"
1216
- }
1217
- },
1218
- "paging" : {
1219
- "$ref" : "#/components/schemas/Paging"
1220
- }
1221
- }
1222
- },
1223
- "PublicDefaultAssociation" : {
1224
- "required" : [ "associationSpec", "from", "to" ],
1225
- "type" : "object",
1226
- "properties" : {
1227
- "from" : {
1228
- "$ref" : "#/components/schemas/PublicObjectId"
1229
- },
1230
- "to" : {
1231
- "$ref" : "#/components/schemas/PublicObjectId"
1232
- },
1233
- "associationSpec" : {
1234
- "$ref" : "#/components/schemas/AssociationSpec"
1235
- }
1236
- }
1237
- },
1238
- "PublicObjectSearchRequest" : {
1239
- "type" : "object",
1240
- "properties" : {
1241
- "query" : {
1242
- "type" : "string",
1243
- "description" : "The search query string, up to 3000 characters."
1244
- },
1245
- "limit" : {
1246
- "type" : "integer",
1247
- "description" : "The maximum results to return, up to 200 objects.",
1248
- "format" : "int32"
1249
- },
1250
- "after" : {
1251
- "type" : "string",
1252
- "description" : "A paging cursor token for retrieving subsequent pages."
1253
- },
1254
- "sorts" : {
1255
- "type" : "array",
1256
- "description" : "Specifies sorting order based on object properties.",
1257
- "items" : {
1258
- "type" : "string"
1259
- }
1260
- },
1261
- "properties" : {
1262
- "type" : "array",
1263
- "description" : "A list of property names to include in the response.",
1264
- "items" : {
1265
- "type" : "string"
1266
- }
1267
- },
1268
- "filterGroups" : {
1269
- "type" : "array",
1270
- "description" : "Up to 6 groups of filters defining additional query criteria.",
1271
- "items" : {
1272
- "$ref" : "#/components/schemas/FilterGroup"
1273
- }
1274
- }
1275
- },
1276
- "description" : "Describes a search request"
1277
- },
1278
- "Error" : {
1279
- "required" : [ "category", "correlationId", "message" ],
1280
- "type" : "object",
1281
- "properties" : {
1282
- "subCategory" : {
1283
- "type" : "string",
1284
- "description" : "A specific category that contains more specific detail about the error"
1285
- },
1286
- "context" : {
1287
- "type" : "object",
1288
- "additionalProperties" : {
1289
- "type" : "array",
1290
- "items" : {
1291
- "type" : "string"
1292
- }
1293
- },
1294
- "description" : "Context about the error condition",
1295
- "example" : "{\"missingScopes\":[\"scope1\",\"scope2\"],\"invalidPropertyName\":[\"propertyValue\"]}"
1296
- },
1297
- "correlationId" : {
1298
- "type" : "string",
1299
- "description" : "A unique identifier for the request. Include this value with any error reports or support tickets",
1300
- "format" : "uuid",
1301
- "example" : "aeb5f871-7f07-4993-9211-075dc63e7cbf"
1302
- },
1303
- "links" : {
1304
- "type" : "object",
1305
- "additionalProperties" : {
1306
- "type" : "string"
1307
- },
1308
- "description" : "A map of link names to associated URIs containing documentation about the error or recommended remediation steps",
1309
- "example" : "{\"knowledge-base\":\"https://www.hubspot.com/products/service/knowledge-base\"}"
1310
- },
1311
- "message" : {
1312
- "type" : "string",
1313
- "description" : "A human readable message describing the error along with remediation steps where appropriate",
1314
- "example" : "Invalid input (details will vary based on the error)"
1315
- },
1316
- "category" : {
1317
- "type" : "string",
1318
- "description" : "The error category",
1319
- "example" : "VALIDATION_ERROR"
1320
- },
1321
- "errors" : {
1322
- "type" : "array",
1323
- "description" : "further information about the error",
1324
- "items" : {
1325
- "$ref" : "#/components/schemas/ErrorDetail"
1326
- }
1327
- }
1328
- },
1329
- "example" : {
1330
- "message" : "Invalid input (details will vary based on the error)",
1331
- "correlationId" : "aeb5f871-7f07-4993-9211-075dc63e7cbf",
1332
- "category" : "VALIDATION_ERROR",
1333
- "links" : {
1334
- "knowledge-base" : "https://www.hubspot.com/products/service/knowledge-base"
1335
- }
1336
- }
1337
- },
1338
- "SimplePublicObjectBatchInputUpsert" : {
1339
- "required" : [ "id", "properties" ],
1340
- "type" : "object",
1341
- "properties" : {
1342
- "idProperty" : {
1343
- "type" : "string",
1344
- "description" : "The name of a property whose values are unique for this object"
1345
- },
1346
- "objectWriteTraceId" : {
1347
- "type" : "string",
1348
- "description" : "In each input object, set this field to a unique ID value to enable more granular debugging for error responses. Learn more about [multi-status errors](https://developers.hubspot.com/docs/reference/api/other-resources/error-handling#multi-status-errors)."
1349
- },
1350
- "id" : {
1351
- "type" : "string",
1352
- "description" : "The ID of the company to update."
1353
- },
1354
- "properties" : {
1355
- "type" : "object",
1356
- "additionalProperties" : {
1357
- "type" : "string"
1358
- },
1359
- "description" : "The company property values to set."
1360
- }
1361
- },
1362
- "description" : "Represents an object used in batch upsert operations, containing an object’s unique identifier, its properties, and optionally the unique property name and a write trace ID."
1363
- },
1364
- "PublicGdprDeleteInput" : {
1365
- "required" : [ "objectId" ],
1366
- "type" : "object",
1367
- "properties" : {
1368
- "idProperty" : {
1369
- "type" : "string",
1370
- "description" : "The name of a unique property, when identifying records by property instead of ID. "
1371
- },
1372
- "objectId" : {
1373
- "type" : "string",
1374
- "description" : "The ID of the company to delete."
1375
- }
1376
- }
1377
- },
1378
- "SimplePublicObjectInput" : {
1379
- "required" : [ "properties" ],
1380
- "type" : "object",
1381
- "properties" : {
1382
- "properties" : {
1383
- "type" : "object",
1384
- "additionalProperties" : {
1385
- "type" : "string"
1386
- },
1387
- "description" : "The company property values to set.",
1388
- "example" : "{\"property_date\":\"1572480000000\",\"property_radio\":\"option_1\",\"property_number\":\"17\",\"property_string\":\"value\",\"property_checkbox\":\"false\",\"property_dropdown\":\"choice_b\",\"property_multiple_checkboxes\":\"chocolate;strawberry\"}"
1389
- }
1390
- },
1391
- "description" : "Represents the input required to create or update a CRM object, containing an object with property names and their corresponding values.",
1392
- "example" : {
1393
- "properties" : {
1394
- "property_checkbox" : "false",
1395
- "property_date" : "1572480000000",
1396
- "property_dropdown" : "choice_b",
1397
- "property_multiple_checkboxes" : "chocolate;strawberry",
1398
- "property_number" : "17",
1399
- "property_radio" : "option_1",
1400
- "property_string" : "value"
1401
- }
1402
- }
1403
- },
1404
- "BatchResponsePublicDefaultAssociation" : {
1405
- "required" : [ "completedAt", "results", "startedAt", "status" ],
1406
- "type" : "object",
1407
- "properties" : {
1408
- "completedAt" : {
1409
- "type" : "string",
1410
- "format" : "date-time"
1411
- },
1412
- "status" : {
1413
- "type" : "string",
1414
- "enum" : [ "PENDING", "PROCESSING", "CANCELED", "COMPLETE" ]
1415
- },
1416
- "requestedAt" : {
1417
- "type" : "string",
1418
- "format" : "date-time"
1419
- },
1420
- "startedAt" : {
1421
- "type" : "string",
1422
- "format" : "date-time"
1423
- },
1424
- "links" : {
1425
- "type" : "object",
1426
- "additionalProperties" : {
1427
- "type" : "string"
1428
- }
1429
- },
1430
- "results" : {
1431
- "type" : "array",
1432
- "items" : {
1433
- "$ref" : "#/components/schemas/PublicDefaultAssociation"
1434
- }
1435
- },
1436
- "errors" : {
1437
- "type" : "array",
1438
- "items" : {
1439
- "$ref" : "#/components/schemas/StandardError"
1440
- }
1441
- },
1442
- "numErrors" : {
1443
- "type" : "integer",
1444
- "format" : "int32"
1445
- }
1446
- }
1447
- },
1448
- "AssociationSpec" : {
1449
- "required" : [ "associationCategory", "associationTypeId" ],
1450
- "type" : "object",
1451
- "properties" : {
1452
- "associationCategory" : {
1453
- "type" : "string",
1454
- "description" : "For [labeled associations](https://developers.hubspot.com/docs/guides/api/crm/associations/associations-v4#associate-records-with-a-label), the category of the association.",
1455
- "enum" : [ "HUBSPOT_DEFINED", "USER_DEFINED", "INTEGRATOR_DEFINED" ]
1456
- },
1457
- "associationTypeId" : {
1458
- "type" : "integer",
1459
- "description" : "The [association type ID](https://developers.hubspot.com/docs/guides/api/crm/associations/associations-v4#association-type-id-values) (e.g., `4` for contact-to-company associations).",
1460
- "format" : "int32"
1461
- }
1462
- },
1463
- "description" : "Defines the type, direction, and details of the relationship between two CRM objects."
1464
- },
1465
- "PublicMergeInput" : {
1466
- "required" : [ "objectIdToMerge", "primaryObjectId" ],
1467
- "type" : "object",
1468
- "properties" : {
1469
- "objectIdToMerge" : {
1470
- "type" : "string",
1471
- "description" : "The ID of the company to merge into the primary."
1472
- },
1473
- "primaryObjectId" : {
1474
- "type" : "string",
1475
- "description" : "The ID of the primary company, which the other will merge into."
1476
- }
1477
- }
1478
- },
1479
- "CollectionResponseSimplePublicObjectWithAssociations" : {
1480
- "required" : [ "results" ],
1481
- "type" : "object",
1482
- "properties" : {
1483
- "results" : {
1484
- "type" : "array",
1485
- "items" : {
1486
- "$ref" : "#/components/schemas/SimplePublicObjectWithAssociations"
1487
- }
1488
- },
1489
- "paging" : {
1490
- "$ref" : "#/components/schemas/Paging"
1491
- }
1492
- }
1493
- },
1494
- "SimplePublicObjectWithAssociations" : {
1495
- "required" : [ "createdAt", "id", "properties", "updatedAt" ],
1496
- "type" : "object",
1497
- "properties" : {
1498
- "associations" : {
1499
- "type" : "object",
1500
- "additionalProperties" : {
1501
- "$ref" : "#/components/schemas/CollectionResponseAssociatedId"
1502
- },
1503
- "description" : "A list defining relationships with other objects."
1504
- },
1505
- "createdAt" : {
1506
- "type" : "string",
1507
- "description" : "The timestamp when the object was created, in ISO 8601 format.",
1508
- "format" : "date-time"
1509
- },
1510
- "archived" : {
1511
- "type" : "boolean",
1512
- "description" : "Whether the object is archived."
1513
- },
1514
- "archivedAt" : {
1515
- "type" : "string",
1516
- "description" : "The timestamp when the object was archived, in ISO 8601 format.",
1517
- "format" : "date-time"
1518
- },
1519
- "propertiesWithHistory" : {
1520
- "type" : "object",
1521
- "additionalProperties" : {
1522
- "type" : "array",
1523
- "items" : {
1524
- "$ref" : "#/components/schemas/ValueWithTimestamp"
1525
- }
1526
- },
1527
- "description" : "Key-value pairs representing the properties of the object along with their history."
1528
- },
1529
- "id" : {
1530
- "type" : "string",
1531
- "description" : "The unique ID of the object."
1532
- },
1533
- "objectWriteTraceId" : {
1534
- "type" : "string"
1535
- },
1536
- "properties" : {
1537
- "type" : "object",
1538
- "additionalProperties" : {
1539
- "type" : "string",
1540
- "nullable" : true
1541
- },
1542
- "description" : "Key value pairs representing the properties of the object."
1543
- },
1544
- "updatedAt" : {
1545
- "type" : "string",
1546
- "description" : "The timestamp when the object was last updated, in ISO 8601 format.",
1547
- "format" : "date-time"
1548
- }
1549
- },
1550
- "description" : "Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type."
1551
- },
1552
- "Filter" : {
1553
- "required" : [ "operator", "propertyName" ],
1554
- "type" : "object",
1555
- "properties" : {
1556
- "highValue" : {
1557
- "type" : "string",
1558
- "description" : "The upper boundary value when using ranged-based filters."
1559
- },
1560
- "propertyName" : {
1561
- "type" : "string",
1562
- "description" : "The name of the property to apply the filter to."
1563
- },
1564
- "values" : {
1565
- "type" : "array",
1566
- "description" : "The values to match against the property.",
1567
- "items" : {
1568
- "type" : "string"
1569
- }
1570
- },
1571
- "value" : {
1572
- "type" : "string",
1573
- "description" : "The value to match against the property."
1574
- },
1575
- "operator" : {
1576
- "type" : "string",
1577
- "description" : "null",
1578
- "enum" : [ "EQ", "NEQ", "LT", "LTE", "GT", "GTE", "BETWEEN", "IN", "NOT_IN", "HAS_PROPERTY", "NOT_HAS_PROPERTY", "CONTAINS_TOKEN", "NOT_CONTAINS_TOKEN" ]
1579
- }
1580
- },
1581
- "description" : "Defines a single condition for searching CRM objects, specifying the property to filter on, the operator to use (such as equals, greater than, or contains), and the value(s) to compare against. "
1582
- },
1583
- "BatchInputSimplePublicObjectBatchInput" : {
1584
- "required" : [ "inputs" ],
1585
- "type" : "object",
1586
- "properties" : {
1587
- "inputs" : {
1588
- "type" : "array",
1589
- "items" : {
1590
- "$ref" : "#/components/schemas/SimplePublicObjectBatchInput"
1591
- }
1592
- }
1593
- }
1594
- },
1595
- "PreviousPage" : {
1596
- "required" : [ "before" ],
1597
- "type" : "object",
1598
- "properties" : {
1599
- "before" : {
1600
- "type" : "string",
1601
- "description" : "A paging cursor token for retrieving previous pages."
1602
- },
1603
- "link" : {
1604
- "type" : "string",
1605
- "description" : "A URL that can be used to retrieve the previous pages' results."
1606
- }
1607
- },
1608
- "description" : "specifies the paging information needed to retrieve the previous set of results in a paginated API response"
1609
- },
1610
- "SimplePublicUpsertObject" : {
1611
- "required" : [ "createdAt", "id", "new", "properties", "updatedAt" ],
1612
- "type" : "object",
1613
- "properties" : {
1614
- "createdAt" : {
1615
- "type" : "string",
1616
- "description" : "The timestamp when the object was created, in ISO 8601 format.",
1617
- "format" : "date-time"
1618
- },
1619
- "archived" : {
1620
- "type" : "boolean",
1621
- "description" : "Whether the object is archived."
1622
- },
1623
- "archivedAt" : {
1624
- "type" : "string",
1625
- "description" : "The timestamp when the object was archived, in ISO 8601 format.",
1626
- "format" : "date-time"
1627
- },
1628
- "new" : {
1629
- "type" : "boolean",
1630
- "description" : "Whether the property is new."
1631
- },
1632
- "propertiesWithHistory" : {
1633
- "type" : "object",
1634
- "additionalProperties" : {
1635
- "type" : "array",
1636
- "items" : {
1637
- "$ref" : "#/components/schemas/ValueWithTimestamp"
1638
- }
1639
- },
1640
- "description" : "Key-value pairs representing the properties of the object along with their history."
1641
- },
1642
- "id" : {
1643
- "type" : "string",
1644
- "description" : "The unique ID of the object."
1645
- },
1646
- "objectWriteTraceId" : {
1647
- "type" : "string"
1648
- },
1649
- "properties" : {
1650
- "type" : "object",
1651
- "additionalProperties" : {
1652
- "type" : "string"
1653
- },
1654
- "description" : "Key value pairs representing the properties of the object."
1655
- },
1656
- "updatedAt" : {
1657
- "type" : "string",
1658
- "description" : "The timestamp when the object was last updated, in ISO 8601 format.",
1659
- "format" : "date-time"
1660
- }
1661
- },
1662
- "description" : "Represents a CRM object that has either been created or updated (upserted)"
1663
- },
1664
- "SimplePublicObjectBatchInput" : {
1665
- "required" : [ "id", "properties" ],
1666
- "type" : "object",
1667
- "properties" : {
1668
- "idProperty" : {
1669
- "type" : "string",
1670
- "description" : "The name of a property whose values are unique for this object",
1671
- "example" : "my_unique_property_name"
1672
- },
1673
- "objectWriteTraceId" : {
1674
- "type" : "string",
1675
- "description" : "In each input object, set this field to a unique ID value to enable more granular debugging for error responses. Learn more about [multi-status errors](https://developers.hubspot.com/docs/reference/api/other-resources/error-handling#multi-status-errors)."
1676
- },
1677
- "id" : {
1678
- "type" : "string",
1679
- "description" : "The ID to be updated. This can be the object ID, or the unique property value of the `idProperty` property."
1680
- },
1681
- "properties" : {
1682
- "type" : "object",
1683
- "additionalProperties" : {
1684
- "type" : "string"
1685
- },
1686
- "description" : "The company property values to set."
1687
- }
1688
- },
1689
- "description" : "Contains an array of CRM object records to be processed in a batch operation, each defined by their ID and properties."
1690
- },
1691
- "SimplePublicObjectBatchInputForCreate" : {
1692
- "required" : [ "properties" ],
1693
- "type" : "object",
1694
- "properties" : {
1695
- "associations" : {
1696
- "type" : "array",
1697
- "items" : {
1698
- "$ref" : "#/components/schemas/PublicAssociationsForObject"
1699
- }
1700
- },
1701
- "objectWriteTraceId" : {
1702
- "type" : "string"
1703
- },
1704
- "properties" : {
1705
- "type" : "object",
1706
- "additionalProperties" : {
1707
- "type" : "string"
1708
- }
1709
- }
1710
- }
1711
- },
1712
- "AssociatedId" : {
1713
- "required" : [ "id", "type" ],
1714
- "type" : "object",
1715
- "properties" : {
1716
- "id" : {
1717
- "type" : "string",
1718
- "description" : "The ID for the association type."
1719
- },
1720
- "type" : {
1721
- "type" : "string",
1722
- "description" : "The type of association.",
1723
- "example" : "deal_to_contact"
1724
- }
1725
- },
1726
- "description" : "Contains the id and type of an association"
1727
- },
1728
- "NextPage" : {
1729
- "required" : [ "after" ],
1730
- "type" : "object",
1731
- "properties" : {
1732
- "link" : {
1733
- "type" : "string",
1734
- "description" : "A URL that can be used to retrieve the next page results.",
1735
- "example" : "?after=NTI1Cg%3D%3D"
1736
- },
1737
- "after" : {
1738
- "type" : "string",
1739
- "description" : "A paging cursor token for retrieving subsequent pages.",
1740
- "example" : "NTI1Cg%3D%3D"
1741
- }
1742
- },
1743
- "description" : "Specifies the paging information needed to retrieve the next set of results in a paginated API response",
1744
- "example" : {
1745
- "after" : "NTI1Cg%3D%3D",
1746
- "link" : "?after=NTI1Cg%3D%3D"
1747
- }
1748
- },
1749
- "SimplePublicObjectInputForCreate" : {
1750
- "required" : [ "properties" ],
1751
- "type" : "object",
1752
- "properties" : {
1753
- "associations" : {
1754
- "type" : "array",
1755
- "items" : {
1756
- "$ref" : "#/components/schemas/PublicAssociationsForObject"
1757
- }
1758
- },
1759
- "properties" : {
1760
- "type" : "object",
1761
- "additionalProperties" : {
1762
- "type" : "string"
1763
- },
1764
- "description" : "The company property values to set."
1765
- }
1766
- },
1767
- "description" : "Is the input object used to create a new CRM object, containing the properties to be set and optional associations to link the new record with other CRM objects."
1768
- },
1769
- "BatchInputSimplePublicObjectBatchInputForCreate" : {
1770
- "required" : [ "inputs" ],
1771
- "type" : "object",
1772
- "properties" : {
1773
- "inputs" : {
1774
- "type" : "array",
1775
- "items" : {
1776
- "$ref" : "#/components/schemas/SimplePublicObjectBatchInputForCreate"
1777
- }
1778
- }
1779
- }
1780
- }
1781
- },
1782
- "responses" : {
1783
- "Error" : {
1784
- "description" : "An error occurred.",
1785
- "content" : {
1786
- "*/*" : {
1787
- "schema" : {
1788
- "$ref" : "#/components/schemas/Error"
1789
- }
1790
- }
1791
- }
1792
- }
1793
- },
1794
- "securitySchemes" : {
1795
- "oauth2" : {
1796
- "type" : "oauth2",
1797
- "flows" : {
1798
- "authorizationCode" : {
1799
- "authorizationUrl" : "https://app.hubspot.com/oauth/authorize",
1800
- "tokenUrl" : "https://api.hubapi.com/oauth/v1/token",
1801
- "scopes" : {
1802
- "oauth" : "User and Account Information",
1803
- "crm.objects.deals.read" : "View deal records",
1804
- "crm.objects.subscriptions.read" : "Read Commerce Subscriptions",
1805
- "crm.objects.services.read" : "Read services",
1806
- "crm.objects.orders.read" : "Read Orders",
1807
- "crm.objects.listings.write" : "Write listings",
1808
- "crm.objects.custom.read" : "View custom object records",
1809
- "crm.objects.companies.write" : "View company records",
1810
- "crm.objects.custom.sensitive.write.v2" : "Change custom object records (sensitive)",
1811
- "crm.objects.custom.highly_sensitive.write.v2" : "Change custom object records (highly-sensitive)",
1812
- "crm.objects.companies.read" : "Create or update company records",
1813
- "crm.objects.appointments.sensitive.read.v2" : "Read appointments (sensitive)",
1814
- "crm.objects.contacts.highly_sensitive.read.v2" : "View contact records (highly-sensitive)",
1815
- "crm.objects.companies.sensitive.read.v2" : "View sensitive properties on company records",
1816
- "media_bridge.read" : "Read media and media events",
1817
- "crm.objects.deals.highly_sensitive.read.v2" : "View deal records (highly-sensitive)",
1818
- "crm.objects.contacts.highly_sensitive.write.v2" : "Change contact records (highly-sensitive)",
1819
- "crm.objects.companies.highly_sensitive.read.v2" : "View company records (highly-sensitive)",
1820
- "crm.objects.commercepayments.write" : "Write commerce payments",
1821
- "crm.objects.invoices.write" : "Write invoices",
1822
- "crm.objects.contacts.sensitive.write.v2" : "Create or update sensitive properties on contact records",
1823
- "crm.objects.users.write" : "Write User CRM objects",
1824
- "crm.objects.custom.sensitive.read.v2" : "View custom object records (sensitive)",
1825
- "crm.objects.users.read" : "Read User CRM objects",
1826
- "crm.objects.partner-services.read" : "View Partner Service CRM objects",
1827
- "crm.objects.orders.write" : "Write orders",
1828
- "crm.objects.partner-services.write" : "Modify Partner Service CRM objects",
1829
- "crm.objects.appointments.write" : "Write appointments",
1830
- "crm.objects.carts.write" : "Write cart",
1831
- "crm.objects.commercepayments.read" : "Read the COMMERCE_PAYMENT object.",
1832
- "crm.objects.products.write" : "Write to my Product Library",
1833
- "crm.objects.services.write" : "Write services",
1834
- "crm.objects.subscriptions.write" : "Write to Commerce Subscriptions",
1835
- "crm.objects.deals.sensitive.write.v2" : "Create or update sensitive properties on deal records",
1836
- "crm.objects.contacts.read" : "View contact records",
1837
- "crm.objects.appointments.sensitive.write.v2" : "Write appointments (sensitive)",
1838
- "crm.objects.invoices.read" : "Read invoices objects",
1839
- "tickets.sensitive.v2" : "Tickets (sensitive)",
1840
- "crm.objects.custom.write" : "Change custom object records",
1841
- "crm.objects.deals.write" : "Create or update deal records",
1842
- "crm.objects.appointments.read" : "Read appointments",
1843
- "crm.objects.companies.sensitive.write.v2" : "Create or update sensitive properties on company records",
1844
- "crm.objects.deals.highly_sensitive.write.v2" : "Change deal records (highly-sensitive)",
1845
- "crm.objects.custom.highly_sensitive.read.v2" : "View custom object records (highly-sensitive)",
1846
- "crm.objects.companies.highly_sensitive.write.v2" : "Change company records (highly-sensitive)",
1847
- "crm.objects.goals.write" : "Write goals",
1848
- "crm.objects.line_items.write" : "Line Items",
1849
- "crm.objects.contacts.write" : "Create or update contact records",
1850
- "crm.objects.goals.read" : "Read goals",
1851
- "crm.objects.partner-clients.write" : "Modify Partner Client CRM objects",
1852
- "crm.objects.line_items.read" : "Line Items",
1853
- "crm.objects.deals.sensitive.read.v2" : "View sensitive properties on deal records",
1854
- "tickets.highly_sensitive.v2" : "Tickets (highly-sensitive)",
1855
- "crm.objects.quotes.write" : "Quotes",
1856
- "crm.objects.leads.read" : "Read lead objects",
1857
- "crm.objects.leads.write" : "Modify lead objects",
1858
- "crm.objects.carts.read" : "Read carts",
1859
- "crm.objects.quotes.read" : "Quotes",
1860
- "crm.objects.courses.write" : "Write courses",
1861
- "crm.objects.partner-clients.read" : "View Partner Client CRM objects",
1862
- "crm.objects.courses.read" : "Read courses",
1863
- "crm.objects.listings.read" : "Read listings",
1864
- "crm.objects.contacts.sensitive.read.v2" : "View sensitive properties on contact records",
1865
- "crm.objects.products.read" : "Read from my Product Library"
1866
- }
1867
- }
1868
- }
1869
- },
1870
- "private_apps_legacy" : {
1871
- "type" : "apiKey",
1872
- "name" : "private-app-legacy",
1873
- "in" : "header"
1874
- },
1875
- "private_apps" : {
1876
- "type" : "apiKey",
1877
- "name" : "private-app",
1878
- "in" : "header"
1879
- }
1880
- }
1881
- },
1882
- "x-hubspot-available-client-libraries" : [ "Node", "Python", "Ruby", "PHP" ],
1883
- "x-hubspot-product-tier-requirements" : {
1884
- "marketing" : "FREE",
1885
- "sales" : "FREE",
1886
- "service" : "FREE",
1887
- "cms" : "FREE"
1888
- }
1889
- }