· 8 years ago · Mar 20, 2018, 07:04 AM
1{
2 "openapi": "3.0.1",
3 "basePath": "",
4 "info": {
5 "contact": {},
6 "license": {
7 "name": "MIT"
8 },
9 "version": "1.0.0-SNAPSHOT"
10 },
11 "paths": {
12 "/siteTrackingDomains": {
13 "post": {
14 "operationId": "addDomainToWhitelist",
15 "description": "Add a domain to the site tracking whitelist"
16 },
17 "get": {
18 "operationId": "listAllWhitelistedDomains",
19 "description": "List of all whitelisted site tracking domains"
20 }
21 },
22 "/connections": {
23 "post": {
24 "operationId": "createAConnection",
25 "description": "Create a new connection resource."
26 },
27 "get": {
28 "operationId": "listAllConnections",
29 "description": "List all existing connection resources."
30 }
31 },
32 "/ecomCustomers": {
33 "post": {
34 "operationId": "createACustomer",
35 "description": "Create a new e-commerce customer resource."
36 },
37 "get": {
38 "operationId": "listAllCustomers",
39 "description": "List all e-commerce customer resources."
40 }
41 },
42 "/deals": {
43 "post": {
44 "operationId": "createADeal",
45 "description": "Create a new deal"
46 },
47 "get": {
48 "operationId": "listAllDeals",
49 "description": "Retrieve all existing deals"
50 }
51 },
52 "/deals/id/notes": {
53 "post": {
54 "operationId": "createADealNote",
55 "description": "Create a new note for a deal"
56 }
57 },
58 "/dealStages": {
59 "post": {
60 "operationId": "createADealStage",
61 "description": "Create a new stage for a pipeline"
62 },
63 "get": {
64 "operationId": "listAllDealStages",
65 "description": "Retrieve all existing stages"
66 }
67 },
68 "/dealTasktypes": {
69 "post": {
70 "operationId": "createADealTaskType",
71 "description": "Create a new task type"
72 },
73 "get": {
74 "operationId": "listAllDealTaskTypes",
75 "description": "Retrieve all existing task types"
76 }
77 },
78 "/eventTrackingEvent": {
79 "post": {
80 "operationId": "createANewEventNameOnly",
81 "description": "Create a new event tracking event (name only)"
82 }
83 },
84 "/dealTasks": {
85 "post": {
86 "operationId": "createANewTask",
87 "description": "Create a new task"
88 },
89 "get": {
90 "operationId": "listAllTasks",
91 "description": "Retrieve a list of existing tasks"
92 }
93 },
94 "/dealGroups": {
95 "post": {
96 "operationId": "createAPipeline",
97 "description": "Create a new pipeline"
98 },
99 "get": {
100 "operationId": "listAllPipelines",
101 "description": "Retrieve all existing pipelines"
102 }
103 },
104 "/users": {
105 "post": {
106 "operationId": "createAUser",
107 "description": "Create a new user"
108 },
109 "get": {
110 "operationId": "listAllUsers",
111 "description": "List all existing users"
112 }
113 },
114 "/webhooks": {
115 "post": {
116 "operationId": "createAWebhook",
117 "description": "Create a new webhook"
118 },
119 "get": {
120 "operationId": "listAllWebhooks",
121 "description": "List all existing webhooks"
122 }
123 },
124 "/ecomOrders": {
125 "post": {
126 "operationId": "createAnOrder",
127 "description": "Create a new e-commerce order resource."
128 },
129 "get": {
130 "operationId": "listAllOrders",
131 "description": "List all existing e-commerce order resources."
132 }
133 },
134 "/organizations": {
135 "post": {
136 "operationId": "createAnOrganization",
137 "description": "Create a new organization"
138 },
139 "get": {
140 "operationId": "listAllOrganizations",
141 "description": "List all existing organizations"
142 }
143 },
144 "/connections/id": {
145 "get": {
146 "operationId": "updateAConnection",
147 "description": "Update an existing connection resource."
148 }
149 },
150 "/ecomCustomer/id": {
151 "get": {
152 "operationId": "deleteACustomer",
153 "description": "Delete an existing e-commerce customer resource."
154 }
155 },
156 "/deals/id": {
157 "get": {
158 "operationId": "updateADeal",
159 "description": "Update an existing deal"
160 }
161 },
162 "/dealStages/id": {
163 "get": {
164 "operationId": "updateADealStage",
165 "description": "Update an existing stage"
166 }
167 },
168 "/dealTasktypes/id": {
169 "get": {
170 "operationId": "updateADealTaskType",
171 "description": "Update an existing task type"
172 }
173 },
174 "/dealGroups/id": {
175 "get": {
176 "operationId": "updateAPipeline",
177 "description": "Update an existing pipeline"
178 }
179 },
180 "/dealTasks/id": {
181 "get": {
182 "operationId": "updateATask",
183 "description": "Update an existing task"
184 }
185 },
186 "/users/:id": {
187 "get": {
188 "operationId": "updateAUser",
189 "description": "Update an existing user"
190 }
191 },
192 "/webhooks/id": {
193 "get": {
194 "operationId": "updateAWebhook",
195 "description": "Update an existing webhook"
196 }
197 },
198 "/ecomOrders/id": {
199 "get": {
200 "operationId": "updateAnOrder",
201 "description": "Update an existing e-commerce resource."
202 }
203 },
204 "/organizations/id": {
205 "get": {
206 "operationId": "updateAnOrganization",
207 "description": "Update an organization"
208 }
209 },
210 "/organizations/bulk_delete": {
211 "get": {
212 "operationId": "deleteMultipleOrganizations",
213 "description": "Delete multiple existing organizations"
214 }
215 },
216 "/siteTracking": {
217 "get": {
218 "operationId": "retrieveStatus",
219 "description": "Get site tracking status (enabled or disabled)"
220 }
221 },
222 "/brandings": {
223 "get": {
224 "operationId": "listAllBrandings",
225 "description": "List all existing branding resources"
226 }
227 },
228 "/eventTrackingEvents": {
229 "get": {
230 "operationId": "listAllEventsNamesOnly",
231 "description": "List the names of tracked events"
232 }
233 },
234 "/webhook/events": {
235 "get": {
236 "operationId": "listAllWebhookEvents",
237 "description": "List all available webhook events"
238 }
239 },
240 "/dealTasktypes/id/dealTasks": {
241 "get": {
242 "operationId": "moveDealTasksToAnotherDealTaskType",
243 "description": "Move tasks to a different task type"
244 }
245 },
246 "/dealStages/id/deals": {
247 "get": {
248 "operationId": "moveDealsToAnotherDealStage",
249 "description": "Move all deals in one stage to another stage"
250 }
251 },
252 "/siteTrackingDomain/name": {
253 "get": {
254 "operationId": "removeDomainFromWhitelist",
255 "description": "Remove a domain from the site tracking whitelist"
256 }
257 },
258 "/eventTrackingEvent/name": {
259 "get": {
260 "operationId": "removeEventNameOnly",
261 "description": "Remove an existing event tracking event (name only)"
262 }
263 },
264 "/brandings/id": {
265 "get": {
266 "operationId": "updateABranding",
267 "description": "Update an existing branding resource"
268 }
269 },
270 "/ecomCustomers/id": {
271 "get": {
272 "operationId": "updateACustomer",
273 "description": "Update an existing e-commerce customer resource."
274 }
275 },
276 "/pipelines/id": {
277 "get": {
278 "operationId": "retrieveAPipeline",
279 "description": "Retrieve an existing pipeline"
280 }
281 },
282 "/users/id": {
283 "get": {
284 "operationId": "retrieveAUser",
285 "description": "Retrieve an existing user"
286 }
287 },
288 "/users/email/:email": {
289 "get": {
290 "operationId": "retrieveAUserByEmail",
291 "description": "Retrieve an existing user by looking up their email address"
292 }
293 },
294 "/users/username/:username": {
295 "get": {
296 "operationId": "retrieveAUserByUsername",
297 "description": "Retrieve an existing user by looking up their username"
298 }
299 },
300 "/users/me": {
301 "get": {
302 "operationId": "retrieveLoggedInUser",
303 "description": "Retrieve the logged-in user"
304 }
305 },
306 "/track/site/code": {
307 "get": {
308 "operationId": "retrieveSiteTrackingCode",
309 "description": "Get site tracking code"
310 }
311 },
312 "/deals/id/notes/noteid": {
313 "get": {
314 "operationId": "updateADealNote",
315 "description": "Update an existing note for a deal"
316 }
317 }
318 },
319 "components": {
320 "schemas": {
321 "addDomainToWhitelistRequest": {
322 "type": "object",
323 "properties": {
324 "siteTrackingDomain": {
325 "type": "object",
326 "properties": {}
327 },
328 "siteTrackingDomain.name": {
329 "type": "string",
330 "description": "The domain name to add to the whitelist."
331 }
332 }
333 },
334 "createAConnectionRequest": {
335 "type": "object",
336 "properties": {
337 "connection": {
338 "type": "object",
339 "properties": {}
340 },
341 "connection.service": {
342 "type": "string",
343 "description": "The name of the service."
344 },
345 "connection.externalid": {
346 "type": "string",
347 "description": "The id of the account in the external service."
348 },
349 "connection.name": {
350 "type": "string",
351 "description": "The name associated with the account in the external service. Often this will be a company name (e.g., 'My Toystore, Inc.')."
352 },
353 "connection.logoUrl": {
354 "type": "string",
355 "description": "The URL to a logo image for the external service."
356 },
357 "connection.linkUrl": {
358 "type": "string",
359 "description": "The URL to a page where the integration with the external service can be managed in the third-party's website."
360 }
361 }
362 },
363 "createACustomerRequest": {
364 "type": "object",
365 "properties": {
366 "ecomCustomer": {
367 "type": "object",
368 "properties": {}
369 },
370 "ecomCustomer.connectionid": {
371 "type": "string",
372 "description": "The id of the connection object for the service where the customer originates."
373 },
374 "ecomCustomer.externalid": {
375 "type": "string",
376 "description": "The id of the customer in the external service."
377 },
378 "ecomCustomer.email": {
379 "type": "string",
380 "description": "The email address of the customer."
381 }
382 }
383 },
384 "createADealNoteRequest": {
385 "type": "object",
386 "properties": {
387 "id": {
388 "type": "string",
389 "description": "Deal's id to assign new note to"
390 },
391 "note": {
392 "type": "object",
393 "properties": {}
394 },
395 "note.note": {
396 "type": "string",
397 "description": "Deal note's content"
398 }
399 }
400 },
401 "createADealRequest": {
402 "type": "object",
403 "properties": {
404 "deal": {
405 "type": "object",
406 "properties": {}
407 },
408 "deal.title": {
409 "type": "string",
410 "description": "Deal's title."
411 },
412 "deal.contact": {
413 "type": "string",
414 "description": "Deal's primary contact's id."
415 },
416 "deal.value": {
417 "type": "int32",
418 "description": "Deal's value in cents. (i.e. $456.78 => 45678). Must be greater than or equal to zero."
419 },
420 "deal.currency": {
421 "type": "string",
422 "description": "Deal's currency in 3-digit ISO format, lowercased."
423 },
424 "deal.group": {
425 "type": "string",
426 "description": "Deal's pipeline id. Required if deal.stage is not provided. If deal.group is not provided, the stage's pipeline will be assigned to the deal automatically."
427 },
428 "deal.stage": {
429 "type": "string",
430 "description": "Deal's stage id. Required if deal.group is not provided. If deal.stage is not provided, the deal will be assigned with the first stage in the pipeline provided in deal.group."
431 },
432 "deal.owner": {
433 "type": "string",
434 "description": "Deal's owner id. Required if pipeline's auto-assign option is disabled."
435 },
436 "deal.percent": {
437 "type": "int32",
438 "description": "Deal's percentage."
439 },
440 "deal.status": {
441 "type": "int32",
442 "description": "Deal's status. See available values."
443 }
444 }
445 },
446 "createADealStageRequest": {
447 "type": "object",
448 "properties": {
449 "reorder": {
450 "type": "int32",
451 "description": "Whether to reorder stages within the pipeline after creating a new deal stage. Can be one of 0 and 1. If set to 1, new order values will be assigned to all stages within the same pipeline. If deal stages with the same order exists, the stage with the highest id will be assigned with the lowest order"
452 },
453 "dealStage": {
454 "type": "object",
455 "properties": {}
456 },
457 "dealStage.title": {
458 "type": "string",
459 "description": "Deal stage's title"
460 },
461 "dealStage.group": {
462 "type": "string",
463 "description": "Deal stage's pipeline id"
464 },
465 "dealStage.order": {
466 "type": "int32",
467 "description": "Order of the deal stage. If more than one deal stage share the same order value, the order of those deal stages may not be always the same. If dealStage.order is not provided, the order is assigned with (the highest order of deal stages within the same pipeline) + 1"
468 },
469 "dealStage.dealOrder": {
470 "type": "string",
471 "description": "Option and direction to be used to sort deals in the deal stage. The option and direction should be delimited by a space. Direction can be either \"ASC\" or \"DESC\". See available options"
472 },
473 "dealStage.cardRegion1": {
474 "type": "string",
475 "description": "What to show in upper-left corner of Deal Cards. See available values"
476 },
477 "dealStage.cardRegion2": {
478 "type": "string",
479 "description": "What to show in upper-right corner of Deal Cards. See available values"
480 },
481 "dealStage.cardRegion3": {
482 "type": "string",
483 "description": "Whether to show the avatar in Deal Cards. Can be one of show-avatar and hide-avatar. If set to show-avatar, deal cards will show the avatars. If set to hide-avatar, deal cards will hide the avatars"
484 },
485 "dealStage.cardRegion4": {
486 "type": "string",
487 "description": "What to show next to the avatar in Deal Cards. See available values"
488 },
489 "dealStage.cardRegion5": {
490 "type": "string",
491 "description": "What to show in lower-right corner of Deal Cards. See available values"
492 },
493 "dealStage.color": {
494 "type": "string",
495 "description": "Deal Stage's color. 6-character HEX color code without the hashtag. e.g. \"434343\" to assign the hex color value \"#434343\""
496 },
497 "dealStage.width": {
498 "type": "int32",
499 "description": "Deal stage's width in pixels, without px unit"
500 }
501 }
502 },
503 "createADealTaskTypeRequest": {
504 "type": "object",
505 "properties": {
506 "dealTasktype": {
507 "type": "object",
508 "properties": {}
509 },
510 "dealTasktype.title": {
511 "type": "string",
512 "description": "Deal task type's title. The title should be unique among deal task types."
513 }
514 }
515 },
516 "createANewEventNameOnlyRequest": {
517 "type": "object",
518 "properties": {
519 "eventTrackingEvent": {
520 "type": "object",
521 "properties": {}
522 },
523 "eventTrackingEvent.name": {
524 "type": "string",
525 "description": "The name of the event"
526 }
527 }
528 },
529 "createANewTaskRequest": {
530 "type": "object",
531 "properties": {
532 "dealTask": {
533 "type": "object",
534 "properties": {}
535 },
536 "dealTask.title": {
537 "type": "string",
538 "description": "The title to be assigned to the task"
539 },
540 "dealTask.reltype": {
541 "type": "string",
542 "description": "The name of the relating object (see relationships table)"
543 },
544 "dealTask.relid": {
545 "type": "int32",
546 "description": "The id of the relational object for this task"
547 },
548 "dealTask.status": {
549 "type": "int32",
550 "description": "The status to be assigned the task"
551 },
552 "dealTask.note": {
553 "type": "string",
554 "description": "The content describing the task"
555 },
556 "dealTask.duedate": {
557 "type": "date",
558 "description": "Due date of the task"
559 },
560 "dealTask.dealTasktype": {
561 "type": "int32",
562 "description": "The type of the task based on the available Task Types in the account"
563 }
564 }
565 },
566 "createAPipelineRequest": {
567 "type": "object",
568 "properties": {
569 "dealGroup": {
570 "type": "object",
571 "properties": {}
572 },
573 "dealGroup.title": {
574 "type": "string",
575 "description": "Pipeline's title."
576 },
577 "dealGroup.currency": {
578 "type": "string",
579 "description": "Default currency to assign to new deals that belong to this deal group."
580 },
581 "dealGroup.allgroups": {
582 "type": "int32",
583 "description": "Whether all user groups have permission to manage this pipeline. Can be either 1 or 0. If 1, all user groups can manage this pipeline. If 0, only user groups in dealGroup.groups parameter can manage this pipeline."
584 },
585 "dealGroup.allusers": {
586 "type": "int32",
587 "description": "Whether new deals get auto-assigned to all users. Can be either 1 or 0. If 1, new deals are auto-assigned to all users unless auto-assign is disabled. If 0, new deals are auto-assigned to only the users in dealGroup.users parameter."
588 },
589 "dealGroup.autoassign": {
590 "type": "int32",
591 "description": "Deal auto-assign option. Can be one of 0, 1, and 2. If 0, auto-assign is disabled. If 1, Round Robin method is used to auto-assign new deals. If 2, deals are distributed based on deal values."
592 },
593 "dealGroup.users": {
594 "type": "array of strings",
595 "description": "List of user ids to auto-assign new deals to unless auto-assign option is disabled."
596 },
597 "dealGroup.groups": {
598 "type": "array of strings",
599 "description": "List of user group ids to allow managing this pipeline."
600 }
601 }
602 },
603 "createAUserRequest": {
604 "type": "object",
605 "properties": {
606 "user": {
607 "type": "object",
608 "properties": {}
609 },
610 "user.username": {
611 "type": "string",
612 "description": "Username"
613 },
614 "user.email": {
615 "type": "string",
616 "description": "Email address"
617 },
618 "user.firstName": {
619 "type": "string",
620 "description": "First name"
621 },
622 "user.lastName": {
623 "type": "string",
624 "description": "Last name"
625 },
626 "user.group": {
627 "type": "int32",
628 "description": "Group ID"
629 },
630 "user.password": {
631 "type": "string",
632 "description": "Plain text password"
633 }
634 }
635 },
636 "createAWebhookRequest": {
637 "type": "object",
638 "properties": {
639 "webhook": {
640 "type": "object",
641 "properties": {}
642 },
643 "webhook.name": {
644 "type": "string",
645 "description": "A name (or label) to give this webhook."
646 },
647 "webhook.url": {
648 "type": "string",
649 "description": "The URL where the webhook will send the POST request when the event occurs."
650 },
651 "webhook.events": {
652 "type": "array of strings",
653 "description": "The event(s) that will trigger the webhook to fire."
654 },
655 "webhook.sources": {
656 "type": "array of strings",
657 "description": "The source(s) causing an event to occur."
658 },
659 "webhook.listid": {
660 "type": "int32",
661 "description": "The id of a list associated with an event (required for some events)."
662 }
663 }
664 },
665 "createAnOrderRequest": {
666 "type": "object",
667 "properties": {
668 "ecomOrder": {
669 "type": "object",
670 "properties": {}
671 },
672 "ecomOrder.externalid": {
673 "type": "string",
674 "description": "The id of the order in the external service."
675 },
676 "ecomOrder.source": {
677 "type": "int32",
678 "description": "The order source code (0 - sync, 1 - realtime webhook)."
679 },
680 "ecomOrder.email": {
681 "type": "string",
682 "description": "The email address of the customer who placed the order."
683 },
684 "ecomOrder.orderProducts": {
685 "type": "object",
686 "properties": {}
687 },
688 "ecomOrder.orderProducts.name": {
689 "type": "string",
690 "description": "The name of the product"
691 },
692 "ecomOrder.orderProducts.price": {
693 "type": "int32",
694 "description": "The price of the product."
695 },
696 "ecomOrder.orderProducts.quantity": {
697 "type": "int32",
698 "description": "The quantity ordered."
699 },
700 "ecomOrder.orderProducts.externalid": {
701 "type": "string",
702 "description": "The id of the product in the external service."
703 },
704 "ecomOrder.orderProducts.category": {
705 "type": "string",
706 "description": "The category of the product."
707 },
708 "ecomOrder.totalPrice": {
709 "type": "string",
710 "description": "The total price of the order including tax and shipping charges."
711 },
712 "ecomOrder.currency": {
713 "type": "string",
714 "description": "The currency of the order (3-digit ISO code, e.g., 'USD')."
715 },
716 "ecomOrder.connectionid": {
717 "type": "int32",
718 "description": "The id of the connection from which this order originated."
719 },
720 "ecomOrder.customerid": {
721 "type": "int32",
722 "description": "The id of the customer associated with this order."
723 },
724 "ecomOrder.orderNumber": {
725 "type": "string",
726 "description": "The order number in the external system (this may differ from the externalid)."
727 },
728 "ecomOrder.orderUrl": {
729 "type": "string",
730 "description": "The URL for the order in the external service."
731 },
732 "ecomOrder.orderDate": {
733 "type": "date",
734 "description": "The date the order was placed."
735 },
736 "ecomOrder.shippingMethod": {
737 "type": "string",
738 "description": "The shipping method of the order."
739 }
740 }
741 },
742 "createAnOrganizationRequest": {
743 "type": "object",
744 "properties": {
745 "organization": {
746 "type": "object",
747 "properties": {}
748 },
749 "organization.name": {
750 "type": "string",
751 "description": "The name to be assigned to the organization."
752 }
753 }
754 },
755 "deleteAConnectionRequest": {
756 "type": "object",
757 "properties": {
758 "id": {
759 "type": "string",
760 "description": "The id of the connection to delete."
761 }
762 }
763 },
764 "deleteACustomerRequest": {
765 "type": "object",
766 "properties": {
767 "id": {
768 "type": "string",
769 "description": "The id of the customer to delete."
770 }
771 }
772 },
773 "deleteADealRequest": {
774 "type": "object",
775 "properties": {
776 "id": {
777 "type": "int32",
778 "description": "Deal's id"
779 }
780 }
781 },
782 "deleteADealStageRequest": {
783 "type": "object",
784 "properties": {
785 "id": {
786 "type": "int32",
787 "description": "Deal stage's id"
788 }
789 }
790 },
791 "deleteADealTaskTypeRequest": {
792 "type": "object",
793 "properties": {
794 "id": {
795 "type": "int32",
796 "description": "Deal task type's id"
797 }
798 }
799 },
800 "deleteAPipelineRequest": {
801 "type": "object",
802 "properties": {
803 "id": {
804 "type": "int32",
805 "description": "Pipeline's id"
806 }
807 }
808 },
809 "deleteATaskRequest": {
810 "type": "object",
811 "properties": {
812 "id": {
813 "type": "int32",
814 "description": "The task id"
815 }
816 }
817 },
818 "deleteAUserRequest": {
819 "type": "object",
820 "properties": {
821 ":id": {
822 "type": "int32",
823 "description": "ID of the user you wish to delete"
824 }
825 }
826 },
827 "deleteAWebhookRequest": {
828 "type": "object",
829 "properties": {
830 "id": {
831 "type": "int32",
832 "description": "The webhook id"
833 }
834 }
835 },
836 "deleteAnOrderRequest": {
837 "type": "object",
838 "properties": {
839 "id": {
840 "type": "int32",
841 "description": "The id of the order to delete."
842 }
843 }
844 },
845 "deleteAnOrganizationRequest": {
846 "type": "object",
847 "properties": {
848 "id": {
849 "type": "int32",
850 "description": "The organization id"
851 }
852 }
853 },
854 "deleteMultipleOrganizationsRequest": {
855 "type": "object",
856 "properties": {
857 "ids[]": {
858 "type": "array of integers",
859 "description": "A list of organization ids to be deleted."
860 }
861 }
862 },
863 "enableDisableRequest": {
864 "type": "object",
865 "properties": {
866 "siteTracking": {
867 "type": "object",
868 "properties": {}
869 },
870 "siteTracking.enabled": {
871 "type": "boolean",
872 "description": "Whether site tracking should be enabled"
873 }
874 }
875 },
876 "listAllBrandingsRequest": {
877 "type": "object",
878 "properties": {
879 "version": {
880 "type": "string",
881 "description": "ActiveCampaign API version"
882 },
883 "api_key": {
884 "type": "string",
885 "description": "ActiveCampaign API key"
886 }
887 }
888 },
889 "listAllConnectionsRequest": {
890 "type": "object",
891 "properties": {
892 "filters[service]": {
893 "type": "string",
894 "description": "Filter by the external service name."
895 },
896 "filters[externalid]": {
897 "type": "string",
898 "description": "Filter by the external id associated with a connection."
899 }
900 }
901 },
902 "listAllCustomersRequest": {
903 "type": "object",
904 "properties": {
905 "filters[email]": {
906 "type": "string",
907 "description": "Filter by the email address of a customer."
908 },
909 "filters[externalid]": {
910 "type": "string",
911 "description": "Filter by the id of the customer in the external service."
912 },
913 "filters[connectionid]": {
914 "type": "string",
915 "description": "Filter by the id of the connection object for the service where the customer originates."
916 }
917 }
918 },
919 "listAllDealStagesRequest": {
920 "type": "object",
921 "properties": {
922 "filters[title]": {
923 "type": "string",
924 "description": "Filter by deal stages' titles. Any stages whose titles partial-match the filter value are returned"
925 },
926 "filters[d_groupid]": {
927 "type": "string",
928 "description": "Filter by pipeline's id"
929 },
930 "orders[title]": {
931 "type": "string",
932 "description": "Order by deal stage's title"
933 }
934 }
935 },
936 "listAllDealsRequest": {
937 "type": "object",
938 "properties": {
939 "filters[search]": {
940 "type": "string",
941 "description": "Search text to use with search_field parameter."
942 },
943 "filters[search_field]": {
944 "type": "string",
945 "description": "Field to search for. See available values."
946 },
947 "filters[title]": {
948 "type": "string",
949 "description": "Filter by deal's title"
950 },
951 "filters[stage]": {
952 "type": "int32",
953 "description": "Filter by deal's stage"
954 },
955 "filters[group]": {
956 "type": "int32",
957 "description": "Filter by deal's pipeline"
958 },
959 "filters[status]": {
960 "type": "int32",
961 "description": "Filter by deal's status. See available values."
962 },
963 "filters[owner]": {
964 "type": "int32",
965 "description": "Filter by deal's owner"
966 },
967 "filters[nextdate_range]": {
968 "type": "string",
969 "description": "Filter by deal's tasks due dates. See available values."
970 },
971 "filters[tag]": {
972 "type": "string",
973 "description": "Filter by tag names associated with deal's primary contact. See available values."
974 },
975 "filters[tasktype]": {
976 "type": "string",
977 "description": "Filter by deals that have tasks with given type"
978 },
979 "filters[created_before]": {
980 "type": "date",
981 "description": "Returns deals that are created less than given date"
982 },
983 "filters[created_after]": {
984 "type": "date",
985 "description": "Returns deals that are created greater than or equal to given date"
986 },
987 "filters[updated_before]": {
988 "type": "date",
989 "description": "Returns deals that are updated less than given date"
990 },
991 "filters[updated_after]": {
992 "type": "date",
993 "description": "Returns deals that are updated greater than or equal to given date"
994 },
995 "filters[organization]": {
996 "type": "int32",
997 "description": "Filter by deal's primary contact's organization's id"
998 },
999 "filters[minimum_value]": {
1000 "type": "int32",
1001 "description": "In USD with dollar portion. Returns deals whose values are greater than or equal to given value"
1002 },
1003 "filters[maximum_value]": {
1004 "type": "int32",
1005 "description": "In USD with dollar portion. Returns deals whose values are less than or equal to given value"
1006 },
1007 "filters[score_greater_than]": {
1008 "type": "string",
1009 "description": "In a format of <score_id>:<score_value>. Returns deals whose score value is greater than given value"
1010 },
1011 "filters[score_less_than]": {
1012 "type": "string",
1013 "description": "In a format of <score_id>:<score_value>. Returns deals whose score value is less than given value"
1014 },
1015 "filters[score]": {
1016 "type": "string",
1017 "description": "In a format of <score_id>:<score_value>. Returns deals whose score value is equal to given value"
1018 },
1019 "orders[title]": {
1020 "type": "string",
1021 "description": "Order by deal's title."
1022 },
1023 "orders[value]": {
1024 "type": "string",
1025 "description": "Order by deal's value."
1026 },
1027 "orders[cdate]": {
1028 "type": "string",
1029 "description": "Order by deal's created date."
1030 },
1031 "orders[contact_name]": {
1032 "type": "string",
1033 "description": "Order by deal's primary contact's first name."
1034 },
1035 "orders[contact_orgname]": {
1036 "type": "string",
1037 "description": "Order by deal's primary contact's organization name."
1038 },
1039 "orders[next-action]": {
1040 "type": "string",
1041 "description": "Order by deal's next task's due date first. Then append deals with no next task. Lastly append deals with overdue tasks. If dates are the same, order by deal's id."
1042 }
1043 }
1044 },
1045 "listAllOrdersRequest": {
1046 "type": "object",
1047 "properties": {
1048 "filters[connectionid]": {
1049 "type": "int32",
1050 "description": "Filter by the connection id. Must be greater than 0."
1051 },
1052 "filters[externalid]": {
1053 "type": "int32",
1054 "description": "Filter by the external id of the order."
1055 },
1056 "filters[email]": {
1057 "type": "string",
1058 "description": "Filter by the customer email address."
1059 }
1060 }
1061 },
1062 "listAllOrganizationsRequest": {
1063 "type": "object",
1064 "properties": {
1065 "filters[name]": {
1066 "type": "string",
1067 "description": "Filter by the name of the organization."
1068 },
1069 "orders[name]": {
1070 "type": "string",
1071 "description": "Order by name"
1072 },
1073 "orders[contact_count]": {
1074 "type": "string",
1075 "description": "Order by contact count"
1076 },
1077 "orders[deal_count]": {
1078 "type": "string",
1079 "description": "Order by deal count"
1080 }
1081 }
1082 },
1083 "listAllPipelinesRequest": {
1084 "type": "object",
1085 "properties": {
1086 "filters[title]": {
1087 "type": "string",
1088 "description": "Filter by pipeline's title. The filter matches any pipeline titles that contain the provided title (i.e. \"Contact\" matches all of \"In Contact\", \"To Contact\", and \"Contact Pipeline\")."
1089 },
1090 "filters[have_stages]": {
1091 "type": "int32",
1092 "description": "Filter by whether pipelines have deal stages. Can be either 1 or 0. If 1, only pipelines with at least one stage will be returned."
1093 },
1094 "orders[title]": {
1095 "type": "string",
1096 "description": "Order by Pipeline's title"
1097 },
1098 "orders[popular]": {
1099 "type": "string",
1100 "description": "Order by number of deals each pipeline has. If pipelines have same number of deals, pipelines' created dates are used to determine the order."
1101 }
1102 }
1103 },
1104 "listAllTasksRequest": {
1105 "type": "object",
1106 "properties": {
1107 "filters[title]": {
1108 "type": "string",
1109 "description": "The title to be assigned to the task"
1110 },
1111 "filters[reltype]": {
1112 "type": "string",
1113 "description": "The name of the relating object (see relationships table)"
1114 },
1115 "filters[relid]": {
1116 "type": "int32",
1117 "description": "The id of the relational object for this task"
1118 },
1119 "filters[status]": {
1120 "type": "int32",
1121 "description": "The status to be assigned the task"
1122 },
1123 "filters[note]": {
1124 "type": "string",
1125 "description": "The content describing the task"
1126 },
1127 "filters[duedate]": {
1128 "type": "date",
1129 "description": "Due date of the task"
1130 },
1131 "filters[d_tasktypeid]": {
1132 "type": "int32",
1133 "description": "The type of the task based on the available Task Types in the account"
1134 },
1135 "filters[userid]": {
1136 "type": "int32",
1137 "description": "User ID this task belongs to"
1138 }
1139 }
1140 },
1141 "listAllWebhooksRequest": {
1142 "type": "object",
1143 "properties": {
1144 "filters[name]": {
1145 "type": "string",
1146 "description": "Filter by webhook name"
1147 },
1148 "filters[url]": {
1149 "type": "string",
1150 "description": "Filter by webhook url"
1151 },
1152 "filters[listid]": {
1153 "type": "string",
1154 "description": "Filter by webhook's associated list"
1155 }
1156 }
1157 },
1158 "moveDealTasksToAnotherDealTaskTypeRequest": {
1159 "type": "object",
1160 "properties": {
1161 "id": {
1162 "type": "int32",
1163 "description": "Deal task type's id"
1164 },
1165 "dealTask": {
1166 "type": "object",
1167 "properties": {}
1168 },
1169 "dealTask.dealTasktype": {
1170 "type": "string",
1171 "description": "Deal task type's id to move deal tasks to"
1172 }
1173 }
1174 },
1175 "moveDealsToAnotherDealStageRequest": {
1176 "type": "object",
1177 "properties": {
1178 "id": {
1179 "type": "int32",
1180 "description": "Deal stage's id whose deals are to be moved to another deal stage"
1181 },
1182 "deal": {
1183 "type": "object",
1184 "properties": {}
1185 },
1186 "deal.stage": {
1187 "type": "string",
1188 "description": "Target deal stage's id to move deals to"
1189 }
1190 }
1191 },
1192 "removeDomainFromWhitelistRequest": {
1193 "type": "object",
1194 "properties": {
1195 "name": {
1196 "type": "string",
1197 "description": "The domain name to remove from the whitelist"
1198 }
1199 }
1200 },
1201 "removeEventNameOnlyRequest": {
1202 "type": "object",
1203 "properties": {
1204 "name": {
1205 "type": "string",
1206 "description": "Name of event to delete. Spaces in names are allowed, but must be encoded (for example, \"my%20event\")."
1207 }
1208 }
1209 },
1210 "retrieveABrandingRequest": {
1211 "type": "object",
1212 "properties": {
1213 "id": {
1214 "type": "int32"
1215 }
1216 }
1217 },
1218 "retrieveAConnectionRequest": {
1219 "type": "object",
1220 "properties": {
1221 "id": {
1222 "type": "string",
1223 "description": "The id of the connection to retrieve"
1224 }
1225 }
1226 },
1227 "retrieveACustomerRequest": {
1228 "type": "object",
1229 "properties": {
1230 "id": {
1231 "type": "string",
1232 "description": "The id of the customer to retrieve"
1233 }
1234 }
1235 },
1236 "retrieveADealRequest": {
1237 "type": "object",
1238 "properties": {
1239 "id": {
1240 "type": "int32",
1241 "description": "Deal's id"
1242 }
1243 }
1244 },
1245 "retrieveADealStageRequest": {
1246 "type": "object",
1247 "properties": {
1248 "id": {
1249 "type": "int32",
1250 "description": "Deal stage's id"
1251 }
1252 }
1253 },
1254 "retrieveADealTaskTypeRequest": {
1255 "type": "object",
1256 "properties": {
1257 "id": {
1258 "type": "int32",
1259 "description": "Deal task type's id"
1260 }
1261 }
1262 },
1263 "retrieveAPipelineRequest": {
1264 "type": "object",
1265 "properties": {
1266 "id": {
1267 "type": "string",
1268 "description": "Pipeline's id"
1269 }
1270 }
1271 },
1272 "retrieveATaskRequest": {
1273 "type": "object",
1274 "properties": {
1275 "id": {
1276 "type": "int32",
1277 "description": "The ID of the task"
1278 }
1279 }
1280 },
1281 "retrieveAUserByEmailRequest": {
1282 "type": "object",
1283 "properties": {
1284 ":email": {
1285 "type": "string",
1286 "description": "Email address of the user you want to view"
1287 }
1288 }
1289 },
1290 "retrieveAUserByUsernameRequest": {
1291 "type": "object",
1292 "properties": {
1293 ":username": {
1294 "type": "string",
1295 "description": "Username of the user you want to view"
1296 }
1297 }
1298 },
1299 "retrieveAUserRequest": {
1300 "type": "object",
1301 "properties": {
1302 "id": {
1303 "type": "int32",
1304 "description": "ID of the user you want to view"
1305 }
1306 }
1307 },
1308 "retrieveAWebhookRequest": {
1309 "type": "object",
1310 "properties": {
1311 "id": {
1312 "type": "int32"
1313 }
1314 }
1315 },
1316 "retrieveAnOrderRequest": {
1317 "type": "object",
1318 "properties": {
1319 "id": {
1320 "type": "int32",
1321 "description": "The id of the order to retrieve."
1322 }
1323 }
1324 },
1325 "retrieveAnOrganizationRequest": {
1326 "type": "object",
1327 "properties": {
1328 "id": {
1329 "type": "int32",
1330 "description": "The ID of the organization"
1331 }
1332 }
1333 },
1334 "updateABrandingRequest": {
1335 "type": "object",
1336 "properties": {
1337 "id": {
1338 "type": "int32",
1339 "description": "Branding ID"
1340 },
1341 "branding": {
1342 "type": "object",
1343 "properties": {}
1344 },
1345 "branding.groupid": {
1346 "type": "int32",
1347 "description": "The group ID. This value will always be 3."
1348 },
1349 "branding.siteName": {
1350 "type": "string",
1351 "description": "Title of software. Example: 'ActiveCampaign Email Marketing'"
1352 },
1353 "branding.siteLogo": {
1354 "type": "string"
1355 },
1356 "branding.siteLogoSmall": {
1357 "type": "string",
1358 "description": "URL of small logo. Small logos appear in the header of the admin panel."
1359 },
1360 "branding.headerTextValue": {
1361 "type": "string",
1362 "description": "Content of non-removable header. Example: text header content"
1363 },
1364 "branding.headerHtmlValue": {
1365 "type": "string",
1366 "description": "Content of non-removable header. Example: "
1367 },
1368 "branding.footerTextValue": {
1369 "type": "string",
1370 "description": "Content of non-removeable footer. Example: text footer content"
1371 },
1372 "branding.footerHtmlValue": {
1373 "type": "string",
1374 "description": "Content of non-removeable footer. Example: "
1375 },
1376 "branding.copyright": {
1377 "type": "boolean",
1378 "description": "unknown"
1379 },
1380 "branding.version": {
1381 "type": "boolean",
1382 "description": "unknown"
1383 },
1384 "branding.license": {
1385 "type": "boolean",
1386 "description": "unknown"
1387 },
1388 "branding.links": {
1389 "type": "boolean",
1390 "description": "External links. To enable (which is the default) exclude this parameter entirely. To disable (remove our branding), just pass this parameter with any value."
1391 },
1392 "branding.help": {
1393 "type": "string"
1394 },
1395 "branding.adminTemplateHtm": {
1396 "type": "string",
1397 "description": "The actual HTML template (ONLY AVAILABLE FOR CERTAIN PLANS)"
1398 },
1399 "branding.adminTemplateCss": {
1400 "type": "string",
1401 "description": "The actual CSS. Example: test color: green; (ONLY AVAILABLE FOR CERTAIN PLANS)"
1402 },
1403 "branding.publicTemplateHtm": {
1404 "type": "string",
1405 "description": "The actual HTML template (ONLY AVAILABLE FOR CERTAIN PLANS)"
1406 },
1407 "branding.publicTemplateCss": {
1408 "type": "string",
1409 "description": "The actual CSS. Example: test color: green; (ONLY AVAILABLE FOR CERTAIN PLANS)"
1410 },
1411 "branding.favicon": {
1412 "type": "string",
1413 "description": "URL of the favicon."
1414 }
1415 }
1416 },
1417 "updateAConnectionRequest": {
1418 "type": "object",
1419 "properties": {
1420 "id": {
1421 "type": "string",
1422 "description": "The id of the connection to update"
1423 },
1424 "connection": {
1425 "type": "object",
1426 "properties": {}
1427 },
1428 "connection.service": {
1429 "type": "string",
1430 "description": "The name of the service."
1431 },
1432 "connection.externalid": {
1433 "type": "string",
1434 "description": "The id of the account in the external service."
1435 },
1436 "connection.name": {
1437 "type": "string",
1438 "description": "The name associated with the account in the external service."
1439 },
1440 "connection.logoUrl": {
1441 "type": "string",
1442 "description": "The URL to a logo image for the third-party service."
1443 },
1444 "connection.linkUrl": {
1445 "type": "string",
1446 "description": "The link to the third-party integrator's site."
1447 },
1448 "connection.status": {
1449 "type": "int32",
1450 "description": "The status of the connection (0 = error; 1 = connected)"
1451 },
1452 "connection.syncStatus": {
1453 "type": "int32",
1454 "description": "The status of a sync triggered on the connection (0 = sync stopped; 1 = sync running)."
1455 }
1456 }
1457 },
1458 "updateACustomerRequest": {
1459 "type": "object",
1460 "properties": {
1461 "id": {
1462 "type": "string",
1463 "description": "The id of the customer to update"
1464 },
1465 "ecomCustomer": {
1466 "type": "object",
1467 "properties": {}
1468 },
1469 "ecomCustomer.externalid": {
1470 "type": "string",
1471 "description": "The id of the customer in the external service."
1472 },
1473 "ecomCustomer.connectionid": {
1474 "type": "string",
1475 "description": "The id of the connection object for the service where the customer originates."
1476 },
1477 "ecomCustomer.email": {
1478 "type": "string",
1479 "description": "The email address of the customer."
1480 }
1481 }
1482 },
1483 "updateADealNoteRequest": {
1484 "type": "object",
1485 "properties": {
1486 "id": {
1487 "type": "string",
1488 "description": "Deal's id to assign new note to"
1489 },
1490 "noteid": {
1491 "type": "string",
1492 "description": "Deal note's id to update"
1493 },
1494 "note": {
1495 "type": "object",
1496 "properties": {}
1497 },
1498 "note.note": {
1499 "type": "string",
1500 "description": "Deal note's content"
1501 }
1502 }
1503 },
1504 "updateADealRequest": {
1505 "type": "object",
1506 "properties": {
1507 "id": {
1508 "type": "int32",
1509 "description": "Deal's id"
1510 },
1511 "deal": {
1512 "type": "object",
1513 "properties": {}
1514 },
1515 "deal.title": {
1516 "type": "string",
1517 "description": "Deal's title."
1518 },
1519 "deal.contact": {
1520 "type": "string",
1521 "description": "Deal's primary contact id."
1522 },
1523 "deal.value": {
1524 "type": "int32",
1525 "description": "Deal's value in cents. (i.e. $456.78 => 45678). Must be greater than or equal to zero."
1526 },
1527 "deal.currency": {
1528 "type": "string",
1529 "description": "Deal's currency in 3-digit ISO format, lowercased."
1530 },
1531 "deal.group": {
1532 "type": "string",
1533 "description": "Deal's pipeline id. Deal's stage or deal.stage should belong to deal.group."
1534 },
1535 "deal.stage": {
1536 "type": "string",
1537 "description": "Deal's stage id. deal.stage should belong to Deal's pipeline or deal.group."
1538 },
1539 "deal.owner": {
1540 "type": "string",
1541 "description": "Deal's owner id."
1542 },
1543 "deal.percent": {
1544 "type": "int32",
1545 "description": "Deal's percentage."
1546 },
1547 "deal.status": {
1548 "type": "int32",
1549 "description": "Deal's status. See available values."
1550 }
1551 }
1552 },
1553 "updateADealStageRequest": {
1554 "type": "object",
1555 "properties": {
1556 "id": {
1557 "type": "int32",
1558 "description": "Deal stage's id"
1559 },
1560 "reorder": {
1561 "type": "int32",
1562 "description": "Whether to reorder stages within the pipeline after creating a new deal stage. Can be one of 0 and 1. If set to 1, new order values will be assigned to all stages within the same pipeline. If deal stages with the same order exists, the stage with the highest id will be assigned with the lowest order"
1563 },
1564 "dealStage": {
1565 "type": "object",
1566 "properties": {}
1567 },
1568 "dealStage.title": {
1569 "type": "string",
1570 "description": "Deal stage's title"
1571 },
1572 "dealStage.group": {
1573 "type": "string",
1574 "description": "Deal stage's pipeline id"
1575 },
1576 "dealStage.order": {
1577 "type": "int32",
1578 "description": "Order of the deal stage. If more than one deal stage share the same order value, the order of those deal stages may not be always the same"
1579 },
1580 "dealStage.dealOrder": {
1581 "type": "string",
1582 "description": "Option and direction to be used to sort deals in the deal stage. The option and direction should be delimited by a space. Direction can be either \"ASC\" or \"DESC\". See available options"
1583 },
1584 "dealStage.cardRegion1": {
1585 "type": "string",
1586 "description": "What to show in upper-left corner of Deal Cards. See available values"
1587 },
1588 "dealStage.cardRegion2": {
1589 "type": "string",
1590 "description": "What to show in upper-right corner of Deal Cards. See available values"
1591 },
1592 "dealStage.cardRegion3": {
1593 "type": "string",
1594 "description": "Whether to show the avatar in Deal Cards. Can be one of show-avatar and hide-avatar. If set to show-avatar, deal cards will show the avatars. If set to hide-avatar, deal cards will hide the avatars"
1595 },
1596 "dealStage.cardRegion4": {
1597 "type": "string",
1598 "description": "What to show next to the avatar in Deal Cards. See available values"
1599 },
1600 "dealStage.cardRegion5": {
1601 "type": "string",
1602 "description": "What to show in lower-right corner of Deal Cards. See available values"
1603 },
1604 "dealStage.color": {
1605 "type": "string",
1606 "description": "Deal Stage's color. 6-character HEX color code without the hashtag. e.g. \"434343\" to assign the hex color value \"#434343\""
1607 },
1608 "dealStage.width": {
1609 "type": "int32",
1610 "description": "Deal stage's width in pixels, without px unit"
1611 }
1612 }
1613 },
1614 "updateADealTaskTypeRequest": {
1615 "type": "object",
1616 "properties": {
1617 "id": {
1618 "type": "int32",
1619 "description": "Deal task type's id"
1620 },
1621 "dealTasktype": {
1622 "type": "object",
1623 "properties": {}
1624 },
1625 "dealTasktype.title": {
1626 "type": "string",
1627 "description": "Deal task type's title. The title should be unique among deal task types."
1628 }
1629 }
1630 },
1631 "updateAPipelineRequest": {
1632 "type": "object",
1633 "properties": {
1634 "id": {
1635 "type": "int32",
1636 "description": "Pipeline's id"
1637 },
1638 "dealGroup": {
1639 "type": "object",
1640 "properties": {}
1641 },
1642 "dealGroup.title": {
1643 "type": "string",
1644 "description": "Pipeline's title"
1645 },
1646 "dealGroup.currency": {
1647 "type": "string",
1648 "description": "Default currency to assign to new deals that belong to this deal group."
1649 },
1650 "dealGroup.allgroups": {
1651 "type": "int32",
1652 "description": "Whether all user groups have permission to manage this pipeline. Can be either 1 or 0. If 1, all user groups can manage this pipeline. If 0, only user groups in dealGroup.groups parameter can manage this pipeline."
1653 },
1654 "dealGroup.allusers": {
1655 "type": "int32",
1656 "description": "Whether new deals get auto-assigned to all users. Can be either 1 or 0. If 1, new deals are auto-assigned to all users unless auto-assign is disabled. If 0, new deals are auto-assigned to only the users in dealGroup.users parameter."
1657 },
1658 "dealGroup.autoassign": {
1659 "type": "int32",
1660 "description": "Deal auto-assign option. Can be one of 0, 1, and 2. If 0, auto-assign is disabled. If 1, Round Robin method is used to auto-assign new deals. If 2, deals are distributed based on deal values."
1661 },
1662 "dealGroup.users": {
1663 "type": "array of strings",
1664 "description": "List of user ids to auto-assign new deals to unless auto-assign option is disabled."
1665 },
1666 "dealGroup.groups": {
1667 "type": "array of strings",
1668 "description": "List of user group ids to allow managing this pipeline."
1669 }
1670 }
1671 },
1672 "updateATaskRequest": {
1673 "type": "object",
1674 "properties": {
1675 "id": {
1676 "type": "int32",
1677 "description": "The ID of the task"
1678 },
1679 "dealTask": {
1680 "type": "object",
1681 "properties": {}
1682 },
1683 "dealTask.title": {
1684 "type": "string",
1685 "description": "The title to be assigned to the task"
1686 },
1687 "dealTask.reltype": {
1688 "type": "string",
1689 "description": "The name of the relating object (see relationships table)"
1690 },
1691 "dealTask.relid": {
1692 "type": "int32",
1693 "description": "The id of the relational object for this task"
1694 },
1695 "dealTask.status": {
1696 "type": "int32",
1697 "description": "The status to be assigned the task"
1698 },
1699 "dealTask.note": {
1700 "type": "string",
1701 "description": "The content describing the task"
1702 },
1703 "dealTask.duedate": {
1704 "type": "date",
1705 "description": "Due date of the task"
1706 },
1707 "dealTask.dealTasktype": {
1708 "type": "int32",
1709 "description": "The type of the task based on the available Task Types in the account"
1710 }
1711 }
1712 },
1713 "updateAUserRequest": {
1714 "type": "object",
1715 "properties": {
1716 ":id": {
1717 "type": "int32",
1718 "description": "ID of the user"
1719 },
1720 "user": {
1721 "type": "object",
1722 "properties": {}
1723 },
1724 "user.username": {
1725 "type": "string",
1726 "description": "Username. Username cannot be changed!"
1727 },
1728 "user.password": {
1729 "type": "string",
1730 "description": "Password. Example: 'newpassword'"
1731 },
1732 "user.email": {
1733 "type": "string",
1734 "description": "Email address of the user. Example: 'test@example.com'"
1735 },
1736 "user.firstName": {
1737 "type": "string",
1738 "description": "First name of the user. Example: 'FirstName'"
1739 },
1740 "user.lastName": {
1741 "type": "string",
1742 "description": "Last name of the user. Example: 'LastName'"
1743 },
1744 "user.group": {
1745 "type": "int32",
1746 "description": "Assign to Groups"
1747 }
1748 }
1749 },
1750 "updateAWebhookRequest": {
1751 "type": "object",
1752 "properties": {
1753 "id": {
1754 "type": "int32",
1755 "description": "The webhook id"
1756 },
1757 "webhook": {
1758 "type": "object",
1759 "properties": {}
1760 },
1761 "webhook.name": {
1762 "type": "string",
1763 "description": "A name (or label) to give the webhook."
1764 },
1765 "webhook.url": {
1766 "type": "string",
1767 "description": "The URL where the webhook will send the POST request when the event occurs."
1768 },
1769 "webhook.events": {
1770 "type": "array of strings",
1771 "description": "The The event(s) that will trigger the webhook to fire. that will trigger the webhook to fire."
1772 },
1773 "webhook.sources": {
1774 "type": "array of strings",
1775 "description": "The source(s) causing an event to occur."
1776 },
1777 "webhook.listid": {
1778 "type": "int32",
1779 "description": "The id of a list associated with an event (required for some events)."
1780 }
1781 }
1782 },
1783 "updateAnOrderRequest": {
1784 "type": "object",
1785 "properties": {
1786 "id": {
1787 "type": "int32",
1788 "description": "The id of the order to update"
1789 },
1790 "ecomOrder": {
1791 "type": "object",
1792 "properties": {}
1793 },
1794 "ecomOrder.totalPrice": {
1795 "type": "int32",
1796 "description": "The total price of the order including tax and shipping charges."
1797 },
1798 "ecomOrder.currency": {
1799 "type": "string",
1800 "description": "The currency of the order (3-digit ISO code, e.g., 'USD')."
1801 },
1802 "ecomOrder.orderNumber": {
1803 "type": "string",
1804 "description": "The order number in the external system (this may differ from the externalid)."
1805 },
1806 "ecomOrder.orderUrl": {
1807 "type": "string",
1808 "description": "The URL for the order in the external service."
1809 },
1810 "ecomOrder.orderDate": {
1811 "type": "string",
1812 "description": "The date the order was placed."
1813 },
1814 "ecomOrder.shippingMethod": {
1815 "type": "string",
1816 "description": "The shipping method of the order."
1817 },
1818 "ecomOrder.email": {
1819 "type": "string",
1820 "description": "The email address of the customer who placed the order."
1821 },
1822 "ecomOrder.orderProducts": {
1823 "type": "array of mixed types",
1824 "description": "A list of product objects, each containing information about a product included in the order (see params specified for creating an order."
1825 }
1826 }
1827 },
1828 "updateAnOrganizationRequest": {
1829 "type": "object",
1830 "properties": {
1831 "id": {
1832 "type": "int32",
1833 "description": "The ID of the organization"
1834 },
1835 "organization": {
1836 "type": "object",
1837 "properties": {}
1838 },
1839 "organization.name": {
1840 "type": "string",
1841 "description": "The name of the organization"
1842 }
1843 }
1844 }
1845 },
1846 "responses": {},
1847 "parameters": {},
1848 "examples": {},
1849 "requestBodies": {},
1850 "headers": {},
1851 "securitySchemes": {},
1852 "links": {},
1853 "callbacks": {}
1854 }
1855}