{ "item": [ { "id": "795da3e0-34f7-4e4c-99fb-c21a2ae07579", "name": "Deals", "description": { "content": "Deals endpoints.", "type": "text/plain" }, "item": [ { "id": "c37ca8fb-29b9-4c30-a9df-0c883a868e0b", "name": "List Deal", "request": { "name": "List Deal", "description": { "content": "Lists entities based on the provided ListCommand.", "type": "text/plain" }, "url": { "path": [ "v2", "deals" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "filter", "value": "string" }, { "disabled": false, "key": "page_token", "value": "string" }, { "disabled": false, "key": "order_by", "value": "string" }, { "disabled": false, "key": "page_size", "value": "100" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "b7b12446-d4c2-4835-80a0-beef7d56b0bc", "name": "a response containing the list of entities", "originalRequest": { "url": { "path": [ "v2", "deals" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "100" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"next_page_token\": \"string\",\n \"deals\": [\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"value\": {\n \"amount\": 5358.972147828164,\n \"currency\": \"string\"\n },\n \"contact_ids\": [\n \"string\",\n \"string\"\n ],\n \"stage_id\": \"string\",\n \"stage_assignment_time\": \"1998-02-11T06:46:39.464Z\",\n \"owner_ids\": [\n \"string\",\n \"string\"\n ],\n \"task_ids\": [\n \"string\",\n \"string\"\n ],\n \"order_id\": \"string\",\n \"status\": \"string\",\n \"estimated_close_time\": \"1981-01-11T13:09:45.606Z\",\n \"closed_time\": \"1980-05-14T22:18:03.463Z\",\n \"custom_fields\": {\n \"key_0\": false\n }\n },\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"value\": {\n \"amount\": 7600.254040677576,\n \"currency\": \"string\"\n },\n \"contact_ids\": [\n \"string\",\n \"string\"\n ],\n \"stage_id\": \"string\",\n \"stage_assignment_time\": \"1948-04-11T16:07:26.443Z\",\n \"owner_ids\": [\n \"string\",\n \"string\"\n ],\n \"task_ids\": [\n \"string\",\n \"string\"\n ],\n \"order_id\": \"string\",\n \"status\": \"string\",\n \"estimated_close_time\": \"2001-09-29T00:50:44.754Z\",\n \"closed_time\": \"1998-12-15T15:52:22.774Z\",\n \"custom_fields\": {\n \"key_0\": true,\n \"key_1\": 5483,\n \"key_2\": 2972.757583779142\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8457b606-8fb2-49bd-a1ee-bfcb6c5c5bee", "name": "Create Deal", "request": { "name": "Create Deal", "description": { "content": "Creates a new entity.", "type": "text/plain" }, "url": { "path": [ "v2", "deals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"contacts\": [\n {\n \"primary_contact\": true,\n \"id\": \"string\"\n },\n {\n \"primary_contact\": true,\n \"id\": \"string\"\n }\n ],\n \"name\": \"string\",\n \"owners\": [\n {\n \"id\": \"string\"\n },\n {\n \"id\": \"string\"\n }\n ],\n \"stage_id\": \"string\",\n \"status\": \"string\",\n \"task_ids\": [\n \"string\",\n \"string\"\n ],\n \"value\": {\n \"amount\": 5300.874176197503,\n \"currency\": \"string\"\n },\n \"owner_id\": \"string\",\n \"estimated_close_time\": \"2026-06-27T10:08:09.569Z\",\n \"custom_fields\": {\n \"key_0\": false,\n \"key_1\": \"string\",\n \"key_2\": false\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "375bc2b0-7120-45cd-9c6f-7d283fae5841", "name": "The created entity", "originalRequest": { "url": { "path": [ "v2", "deals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contacts\": [\n {\n \"primary_contact\": true,\n \"id\": \"string\"\n },\n {\n \"primary_contact\": false,\n \"id\": \"string\"\n }\n ],\n \"name\": \"string\",\n \"owners\": [\n {\n \"id\": \"string\"\n },\n {\n \"id\": \"string\"\n }\n ],\n \"stage_id\": \"string\",\n \"status\": \"string\",\n \"task_ids\": [\n \"string\",\n \"string\"\n ],\n \"value\": {\n \"amount\": 8509.568657991395,\n \"currency\": \"string\"\n },\n \"owner_id\": \"string\",\n \"estimated_close_time\": \"2021-12-14T06:13:17.510Z\",\n \"custom_fields\": {\n \"key_0\": 3374,\n \"key_1\": 5692\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"string\",\n \"value\": {\n \"amount\": 3587.069023495848,\n \"currency\": \"string\"\n },\n \"contact_ids\": [\n \"string\",\n \"string\"\n ],\n \"stage_id\": \"string\",\n \"stage_assignment_time\": \"1956-02-06T05:10:10.547Z\",\n \"owner_ids\": [\n \"string\",\n \"string\"\n ],\n \"task_ids\": [\n \"string\",\n \"string\"\n ],\n \"order_id\": \"string\",\n \"status\": \"string\",\n \"estimated_close_time\": \"1952-05-05T15:13:44.605Z\",\n \"closed_time\": \"1970-06-28T08:44:08.975Z\",\n \"custom_fields\": {\n \"key_0\": false,\n \"key_1\": 9350.455511565777\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7f0cff91-bcf8-4044-947b-19ff19a25bbe", "name": "Retrieves a list of deals by their IDs.", "request": { "name": "Retrieves a list of deals by their IDs.", "description": { "content": "Retrieves a list of deals by their IDs.", "type": "text/plain" }, "url": { "path": [ "v2", "deals", "-", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "id", "value": "string", "description": "(Required) the deal IDs to list" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "5fbd866a-d404-485e-b9b5-3cc82a8c7448", "name": "the list of requested Deal", "originalRequest": { "url": { "path": [ "v2", "deals", "-", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "id", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"value\": {\n \"amount\": 1103.1717564244748,\n \"currency\": \"string\"\n },\n \"contact_ids\": [\n \"string\",\n \"string\"\n ],\n \"stage_id\": \"string\",\n \"stage_assignment_time\": \"1996-08-22T00:16:09.830Z\",\n \"owner_ids\": [\n \"string\",\n \"string\"\n ],\n \"task_ids\": [\n \"string\",\n \"string\"\n ],\n \"order_id\": \"string\",\n \"status\": \"string\",\n \"estimated_close_time\": \"2024-08-04T19:07:58.668Z\",\n \"closed_time\": \"1992-06-24T15:29:37.799Z\",\n \"custom_fields\": {\n \"key_0\": \"string\"\n }\n },\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"value\": {\n \"amount\": 4701.190951376903,\n \"currency\": \"string\"\n },\n \"contact_ids\": [\n \"string\",\n \"string\"\n ],\n \"stage_id\": \"string\",\n \"stage_assignment_time\": \"1960-11-02T16:05:53.677Z\",\n \"owner_ids\": [\n \"string\",\n \"string\"\n ],\n \"task_ids\": [\n \"string\",\n \"string\"\n ],\n \"order_id\": \"string\",\n \"status\": \"string\",\n \"estimated_close_time\": \"1963-02-07T14:32:42.449Z\",\n \"closed_time\": \"1949-07-04T06:48:47.746Z\",\n \"custom_fields\": {\n \"key_0\": 5115,\n \"key_1\": 8414\n }\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0196e858-30f3-4acd-9bb9-034b5f195624", "name": "Deletes a list of deals by their IDs.", "request": { "name": "Deletes a list of deals by their IDs.", "description": { "content": "Deletes a list of deals by their IDs.", "type": "text/plain" }, "url": { "path": [ "v2", "deals", "-", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "id", "value": "string", "description": "(Required) each ID of each deal to delete" } ], "variable": [] }, "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "ba19f0dd-3dca-42e3-a815-e44a4ac71611", "name": "deleteDealsInBulk 204 response", "originalRequest": { "url": { "path": [ "v2", "deals", "-", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "id", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "878b0a7f-9354-4107-aaba-c05f50f4483e", "name": "Lists all deals associated with a specific contact.", "request": { "name": "Lists all deals associated with a specific contact.", "description": { "content": "Lists all deals associated with a specific contact.", "type": "text/plain" }, "url": { "path": [ "v2", "deals", "-", "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "filter", "value": "string" }, { "disabled": false, "key": "page_size", "value": "100" }, { "disabled": false, "key": "page_token", "value": "string" }, { "disabled": false, "key": "order_by", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) the contact ID to list deals for" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "be86db38-1485-43cc-a1cb-f885511ca0f1", "name": "a list of deals wrapped in a DealListResponse", "originalRequest": { "url": { "path": [ "v2", "deals", "-", "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_size", "value": "100" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "contact_id", "description": "(Required) the contact ID to list deals for" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"next_page_token\": \"string\",\n \"deals\": [\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"value\": {\n \"amount\": 9442.494041565498,\n \"currency\": \"string\"\n },\n \"contact_ids\": [\n \"string\",\n \"string\"\n ],\n \"stage_id\": \"string\",\n \"stage_assignment_time\": \"1956-11-22T07:03:00.144Z\",\n \"owner_ids\": [\n \"string\",\n \"string\"\n ],\n \"task_ids\": [\n \"string\",\n \"string\"\n ],\n \"order_id\": \"string\",\n \"status\": \"string\",\n \"estimated_close_time\": \"1972-07-22T04:27:31.968Z\",\n \"closed_time\": \"1953-09-09T08:18:50.592Z\",\n \"custom_fields\": {\n \"key_0\": false\n }\n },\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"value\": {\n \"amount\": 7858.226284008348,\n \"currency\": \"string\"\n },\n \"contact_ids\": [\n \"string\",\n \"string\"\n ],\n \"stage_id\": \"string\",\n \"stage_assignment_time\": \"1953-07-27T12:49:20.898Z\",\n \"owner_ids\": [\n \"string\",\n \"string\"\n ],\n \"task_ids\": [\n \"string\",\n \"string\"\n ],\n \"order_id\": \"string\",\n \"status\": \"string\",\n \"estimated_close_time\": \"1988-10-20T03:40:48.000Z\",\n \"closed_time\": \"2012-06-22T20:42:25.331Z\",\n \"custom_fields\": {\n \"key_0\": 6465.594509769943,\n \"key_1\": 8452.539908781006\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c18ac51e-86a2-42b6-b0f5-913314296074", "name": "Creates new notes in bulk.", "request": { "name": "Creates new notes in bulk.", "description": { "content": "Creates new notes in bulk.", "type": "text/plain" }, "url": { "path": [ "v2", "deals", "-", "notes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"create_note_requests\": [\n {\n \"body\": \"string\",\n \"created_by\": \"string\",\n \"deal_id\": \"string\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "bae8b703-f9c7-4759-8dea-fda87892843e", "name": "the created DealNote", "originalRequest": { "url": { "path": [ "v2", "deals", "-", "notes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"create_note_requests\": [\n {\n \"body\": \"string\",\n \"created_by\": \"string\",\n \"deal_id\": \"string\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"create_note_responses\": [\n {\n \"id\": \"string\",\n \"body\": \"string\",\n \"deal_id\": \"string\",\n \"created_by\": \"string\",\n \"created_time\": \"2012-10-15T16:40:27.854Z\",\n \"modified_time\": \"1998-03-07T17:25:52.805Z\",\n \"create_success\": false,\n \"error_message\": \"string\"\n },\n {\n \"id\": \"string\",\n \"body\": \"string\",\n \"deal_id\": \"string\",\n \"created_by\": \"string\",\n \"created_time\": \"2018-02-22T15:02:52.163Z\",\n \"modified_time\": \"1996-11-22T17:08:28.848Z\",\n \"create_success\": false,\n \"error_message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "21ad89b5-3699-4ee7-ac03-265c56ba68bc", "name": "Retrieves a specific deal note by its ID.", "request": { "name": "Retrieves a specific deal note by its ID.", "description": { "content": "Retrieves a specific deal note by its ID.", "type": "text/plain" }, "url": { "path": [ "v2", "deals", "-", "notes", ":note_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "note_id", "description": "(Required) the ID of the note to retrieve" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "65aebf9e-0242-45a8-a4a9-c44a18488ca5", "name": "the requested DealNote", "originalRequest": { "url": { "path": [ "v2", "deals", "-", "notes", ":note_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "note_id", "description": "(Required) the ID of the note to retrieve" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"deal_id\": \"string\",\n \"body\": \"string\",\n \"created_by\": \"string\",\n \"created_time\": \"1980-06-08T02:32:13.226Z\",\n \"modified_time\": \"1997-08-18T06:02:53.640Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b993b931-0717-4bc2-b2f8-c3b665f4f3d7", "name": "Deletes a specific deal note by its ID.", "request": { "name": "Deletes a specific deal note by its ID.", "description": { "content": "Deletes a specific deal note by its ID.", "type": "text/plain" }, "url": { "path": [ "v2", "deals", "-", "notes", ":note_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "note_id", "description": "(Required) the ID of the note to delete" } ] }, "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "474ffb4b-b9ea-4a2f-8554-4bb01aa758e3", "name": "a HttpResponse indicating the result of the delete operation", "originalRequest": { "url": { "path": [ "v2", "deals", "-", "notes", ":note_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "note_id", "description": "(Required) the ID of the note to delete" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1533156c-e096-4699-b882-f37552eb4d05", "name": "Updates a specific deal note by its ID.", "request": { "name": "Updates a specific deal note by its ID.", "description": { "content": "Updates a specific deal note by its ID.", "type": "text/plain" }, "url": { "path": [ "v2", "deals", "-", "notes", ":note_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "note_id", "description": "(Required) the ID of the note to update" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"body\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "ab6d8617-ea2a-4b09-aaec-7cc85a232b20", "name": "the updated DealNote", "originalRequest": { "url": { "path": [ "v2", "deals", "-", "notes", ":note_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "note_id", "description": "(Required) the ID of the note to update" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"body\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"deal_id\": \"string\",\n \"body\": \"string\",\n \"created_by\": \"string\",\n \"created_time\": \"1980-06-08T02:32:13.226Z\",\n \"modified_time\": \"1997-08-18T06:02:53.640Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f7b8e4a3-3b79-42e6-ac78-0d844bec905b", "name": "Creates multiple deals in bulk.", "request": { "name": "Creates multiple deals in bulk.", "description": { "content": "Creates multiple deals in bulk.", "type": "text/plain" }, "url": { "path": [ "v2", "deals", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"create_deal_requests\": [\n {\n \"contacts\": [\n {\n \"primary_contact\": false,\n \"id\": \"string\"\n },\n {\n \"primary_contact\": false,\n \"id\": \"string\"\n }\n ],\n \"external_system_id\": \"string\",\n \"name\": \"string\",\n \"owners\": [\n {\n \"id\": \"string\"\n },\n {\n \"id\": \"string\"\n }\n ],\n \"stage_id\": \"string\",\n \"status\": \"string\",\n \"task_ids\": [\n \"string\",\n \"string\"\n ],\n \"value\": {\n \"amount\": 9551.026928351677,\n \"currency\": \"string\"\n },\n \"owner_id\": \"string\",\n \"estimated_close_time\": \"2023-07-13T22:57:01.056Z\",\n \"custom_fields\": {\n \"key_0\": false\n }\n },\n {\n \"contacts\": [\n {\n \"primary_contact\": true,\n \"id\": \"string\"\n },\n {\n \"primary_contact\": false,\n \"id\": \"string\"\n }\n ],\n \"external_system_id\": \"string\",\n \"name\": \"string\",\n \"owners\": [\n {\n \"id\": \"string\"\n },\n {\n \"id\": \"string\"\n }\n ],\n \"stage_id\": \"string\",\n \"status\": \"string\",\n \"task_ids\": [\n \"string\",\n \"string\"\n ],\n \"value\": {\n \"amount\": 1986.001802875512,\n \"currency\": \"string\"\n },\n \"owner_id\": \"string\",\n \"estimated_close_time\": \"1950-01-24T06:28:52.410Z\",\n \"custom_fields\": {\n \"key_0\": 3492.6489157515707\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "6a037cb2-eb78-4172-ad80-288bf964c208", "name": "the created deals", "originalRequest": { "url": { "path": [ "v2", "deals", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"create_deal_requests\": [\n {\n \"contacts\": [\n {\n \"primary_contact\": true,\n \"id\": \"string\"\n },\n {\n \"primary_contact\": false,\n \"id\": \"string\"\n }\n ],\n \"external_system_id\": \"string\",\n \"name\": \"string\",\n \"owners\": [\n {\n \"id\": \"string\"\n },\n {\n \"id\": \"string\"\n }\n ],\n \"stage_id\": \"string\",\n \"status\": \"string\",\n \"task_ids\": [\n \"string\",\n \"string\"\n ],\n \"value\": {\n \"amount\": 3171.1591815818642,\n \"currency\": \"string\"\n },\n \"owner_id\": \"string\",\n \"estimated_close_time\": \"1961-11-23T14:56:20.064Z\",\n \"custom_fields\": {\n \"key_0\": 4507,\n \"key_1\": 9653,\n \"key_2\": 722\n }\n },\n {\n \"contacts\": [\n {\n \"primary_contact\": false,\n \"id\": \"string\"\n },\n {\n \"primary_contact\": false,\n \"id\": \"string\"\n }\n ],\n \"external_system_id\": \"string\",\n \"name\": \"string\",\n \"owners\": [\n {\n \"id\": \"string\"\n },\n {\n \"id\": \"string\"\n }\n ],\n \"stage_id\": \"string\",\n \"status\": \"string\",\n \"task_ids\": [\n \"string\",\n \"string\"\n ],\n \"value\": {\n \"amount\": 818.8601237851301,\n \"currency\": \"string\"\n },\n \"owner_id\": \"string\",\n \"estimated_close_time\": \"1977-09-04T08:00:15.782Z\",\n \"custom_fields\": {\n \"key_0\": 3600,\n \"key_1\": \"string\",\n \"key_2\": 7305\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"created_deals\": {\n \"key_0\": {\n \"deal_id\": \"string\",\n \"create_success\": true,\n \"error_message\": \"string\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4c2cf1aa-5fb0-4e30-92ad-011c5baa3142", "name": "Moves the active deals of specified contacts from one stage to another, in bulk.", "request": { "name": "Moves the active deals of specified contacts from one stage to another, in bulk.", "description": { "content": "Moves the active deals of specified contacts from one stage to another, in bulk.", "type": "text/plain" }, "url": { "path": [ "v2", "deals", "moveByContactIds" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"contact_ids\": [\n \"string\"\n ],\n \"from_stage\": \"string\",\n \"to_stage\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "5d70b6df-5458-482b-b0e9-3d80495be8f8", "name": "the IDs of the Deals moved", "originalRequest": { "url": { "path": [ "v2", "deals", "moveByContactIds" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_ids\": [\n \"string\"\n ],\n \"from_stage\": \"string\",\n \"to_stage\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"moved_deal_ids\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e324f05b-cd23-46e1-a032-e6f5e6edc412", "name": "Get Deal", "request": { "name": "Get Deal", "description": { "content": "Retrieves an entity by its identifier.", "type": "text/plain" }, "url": { "path": [ "v2", "deals", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the entity identifier" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "958c3764-84fa-45c2-90d6-2899fffc7975", "name": "The retrieved entity", "originalRequest": { "url": { "path": [ "v2", "deals", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the entity identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"string\",\n \"value\": {\n \"amount\": 3587.069023495848,\n \"currency\": \"string\"\n },\n \"contact_ids\": [\n \"string\",\n \"string\"\n ],\n \"stage_id\": \"string\",\n \"stage_assignment_time\": \"1956-02-06T05:10:10.547Z\",\n \"owner_ids\": [\n \"string\",\n \"string\"\n ],\n \"task_ids\": [\n \"string\",\n \"string\"\n ],\n \"order_id\": \"string\",\n \"status\": \"string\",\n \"estimated_close_time\": \"1952-05-05T15:13:44.605Z\",\n \"closed_time\": \"1970-06-28T08:44:08.975Z\",\n \"custom_fields\": {\n \"key_0\": false,\n \"key_1\": 9350.455511565777\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ebdc2ef7-5241-4741-86eb-2babc6af79c9", "name": "Deletes an entity by its identifier.", "request": { "name": "Deletes an entity by its identifier.", "description": { "content": "Deletes an entity by its identifier.", "type": "text/plain" }, "url": { "path": [ "v2", "deals", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the entity identifier" } ] }, "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "cc1257a5-b30f-4c4e-97ad-2b11459020f4", "name": "A response indicating no content", "originalRequest": { "url": { "path": [ "v2", "deals", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the entity identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "289a6cd9-c298-40b1-80aa-a144989b3ebb", "name": "Update Deal", "request": { "name": "Update Deal", "description": { "content": "Updates an existing entity.", "type": "text/plain" }, "url": { "path": [ "v2", "deals", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "update_mask", "value": "string", "description": "(Required) the fields to update" }, { "disabled": false, "key": "update_mask", "value": "string", "description": "(Required) the fields to update" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the entity identifier" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"stage_id\": \"string\",\n \"status\": \"string\",\n \"name\": \"string\",\n \"amount\": 7008.786544044116,\n \"currency_code\": \"string\",\n \"contacts\": [\n {\n \"primary_contact\": true,\n \"id\": \"string\"\n },\n {\n \"primary_contact\": false,\n \"id\": \"string\"\n }\n ],\n \"owners\": [\n {\n \"id\": \"string\"\n },\n {\n \"id\": \"string\"\n }\n ],\n \"owner_id\": \"string\",\n \"task_ids\": [\n \"string\",\n \"string\"\n ],\n \"previous_deal_id\": \"string\",\n \"next_deal_id\": \"string\",\n \"estimated_close_date\": \"1961-01-26T12:59:48.347Z\",\n \"closed_date\": \"2004-07-12T19:26:13.687Z\",\n \"custom_fields\": {\n \"key_0\": true,\n \"key_1\": 6575.203028241821,\n \"key_2\": 6101.368712798567,\n \"key_3\": false\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "66486112-ef98-4c3e-b04f-d88f82a8c2f7", "name": "The updated entity", "originalRequest": { "url": { "path": [ "v2", "deals", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "string" }, { "key": "update_mask", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the entity identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"stage_id\": \"string\",\n \"status\": \"string\",\n \"name\": \"string\",\n \"amount\": 1730.9734231781104,\n \"currency_code\": \"string\",\n \"contacts\": [\n {\n \"primary_contact\": false,\n \"id\": \"string\"\n },\n {\n \"primary_contact\": true,\n \"id\": \"string\"\n }\n ],\n \"owners\": [\n {\n \"id\": \"string\"\n },\n {\n \"id\": \"string\"\n }\n ],\n \"owner_id\": \"string\",\n \"task_ids\": [\n \"string\",\n \"string\"\n ],\n \"previous_deal_id\": \"string\",\n \"next_deal_id\": \"string\",\n \"estimated_close_date\": \"1994-08-30T01:28:01.911Z\",\n \"closed_date\": \"1967-12-25T20:44:33.389Z\",\n \"custom_fields\": {\n \"key_0\": true,\n \"key_1\": 2711.7307698401705\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"string\",\n \"value\": {\n \"amount\": 3587.069023495848,\n \"currency\": \"string\"\n },\n \"contact_ids\": [\n \"string\",\n \"string\"\n ],\n \"stage_id\": \"string\",\n \"stage_assignment_time\": \"1956-02-06T05:10:10.547Z\",\n \"owner_ids\": [\n \"string\",\n \"string\"\n ],\n \"task_ids\": [\n \"string\",\n \"string\"\n ],\n \"order_id\": \"string\",\n \"status\": \"string\",\n \"estimated_close_time\": \"1952-05-05T15:13:44.605Z\",\n \"closed_time\": \"1970-06-28T08:44:08.975Z\",\n \"custom_fields\": {\n \"key_0\": false,\n \"key_1\": 9350.455511565777\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ead77460-3d60-4ecb-953d-4fe29a8af543", "name": "Validates the custom fields in a Deal.", "request": { "name": "Validates the custom fields in a Deal.", "description": { "content": "Validates the custom fields in a Deal.", "type": "text/plain" }, "url": { "path": [ "v2", "deals", ":id", "customFields:validate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the ID of the deal to move" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"custom_fields\": {\n \"key_0\": 1918,\n \"key_1\": 4693\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "7a168d4c-ad77-4d70-ab38-f7206f63738d", "name": "the result of the validation containing errors and warnings", "originalRequest": { "url": { "path": [ "v2", "deals", ":id", "customFields:validate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the ID of the deal to move" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"custom_fields\": {\n \"key_0\": 1918,\n \"key_1\": 4693\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"error_code\": \"string\",\n \"message\": \"string\",\n \"args\": {},\n \"logref\": \"string\"\n },\n {\n \"error_code\": \"string\",\n \"message\": \"string\",\n \"args\": {},\n \"logref\": \"string\"\n }\n ],\n \"warnings\": [\n {\n \"error_code\": \"string\",\n \"message\": \"string\",\n \"args\": {},\n \"logref\": \"string\"\n },\n {\n \"error_code\": \"string\",\n \"message\": \"string\",\n \"args\": {},\n \"logref\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "93c37d17-b50c-400f-a560-6733e6cd07bf", "name": "Lists all notes associated with a specific deal.", "request": { "name": "Lists all notes associated with a specific deal.", "description": { "content": "Lists all notes associated with a specific deal.", "type": "text/plain" }, "url": { "path": [ "v2", "deals", ":id", "notes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "filter", "value": "string" }, { "disabled": false, "key": "page_size", "value": "100" }, { "disabled": false, "key": "page_token", "value": "string" }, { "disabled": false, "key": "order_by", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the deal ID to list notes for" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "23bd33d5-e8ae-4021-a401-a939294ad948", "name": "a list of deal notes wrapped in a DealNoteListResponse", "originalRequest": { "url": { "path": [ "v2", "deals", ":id", "notes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_size", "value": "100" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the deal ID to list notes for" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"next_page_token\": \"string\",\n \"notes\": [\n {\n \"id\": \"string\",\n \"deal_id\": \"string\",\n \"body\": \"string\",\n \"created_by\": \"string\",\n \"created_time\": \"2009-07-10T16:48:47.719Z\",\n \"modified_time\": \"1980-03-05T16:04:30.889Z\"\n },\n {\n \"id\": \"string\",\n \"deal_id\": \"string\",\n \"body\": \"string\",\n \"created_by\": \"string\",\n \"created_time\": \"1951-01-08T18:05:05.839Z\",\n \"modified_time\": \"1987-02-16T11:25:42.671Z\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3332928a-7c97-44b5-bbc4-612bed8407ac", "name": "Creates a new note for a specific deal.", "request": { "name": "Creates a new note for a specific deal.", "description": { "content": "Creates a new note for a specific deal.", "type": "text/plain" }, "url": { "path": [ "v2", "deals", ":id", "notes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the deal ID to associate the new note with" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"body\": \"st\",\n \"created_by\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "cd8a8a65-309e-46a7-a267-abb96d33285a", "name": "the created DealNote", "originalRequest": { "url": { "path": [ "v2", "deals", ":id", "notes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the deal ID to associate the new note with" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"body\": \"st\",\n \"created_by\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"deal_id\": \"string\",\n \"body\": \"string\",\n \"created_by\": \"string\",\n \"created_time\": \"1980-06-08T02:32:13.226Z\",\n \"modified_time\": \"1997-08-18T06:02:53.640Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d0b74c74-c67b-4afb-aa55-873df9c65200", "name": "Retrieves the count of deals based on the specified filter criteria.", "request": { "name": "Retrieves the count of deals based on the specified filter criteria.", "description": { "content": "Retrieves the count of deals based on the specified filter criteria.", "type": "text/plain" }, "url": { "path": [ "v2", "deals", "{{id}}:count" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "filter", "value": "string" }, { "disabled": false, "key": "page_size", "value": "100" }, { "disabled": false, "key": "page_token", "value": "string" }, { "disabled": false, "key": "order_by", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "ad10f0f4-5b0b-4ada-b7b8-3b274851a0bf", "name": "the count of deals matching the specified filter criteria.", "originalRequest": { "url": { "path": [ "v2", "deals", "{{id}}:count" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_size", "value": "100" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "7260", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c767bca5-21b1-4b2e-aedb-837dfb06697f", "name": "Moves the specified deal to a specified stage.", "request": { "name": "Moves the specified deal to a specified stage.", "description": { "content": "Moves the specified deal to a specified stage.", "type": "text/plain" }, "url": { "path": [ "v2", "deals", "{{id}}:move" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "string", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "cd7b5499-5129-464c-be64-8618198b33a4", "name": "the IDs of the Deals moved", "originalRequest": { "url": { "path": [ "v2", "deals", "{{id}}:move" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "string", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "0314c110-d74b-474d-af22-d18838002097", "name": "Deals Custom Fields", "description": { "content": "Deals Custom Fields endpoints.", "type": "text/plain" }, "item": [ { "id": "66ddec86-9d35-4687-8f86-ffa7304c5bbc", "name": "Retrieves a list of custom fields in a tenant.", "request": { "name": "Retrieves a list of custom fields in a tenant.", "description": { "content": "Retrieves a list of custom fields in a tenant.", "type": "text/plain" }, "url": { "path": [ "v2", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "filter", "value": "string" }, { "disabled": false, "key": "page_token", "value": "string" }, { "disabled": false, "key": "order_by", "value": "string" }, { "disabled": false, "key": "page_size", "value": "100" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "2931d070-0499-45d2-a97f-21422ddf5005", "name": "a list of PipelineCustomFields", "originalRequest": { "url": { "path": [ "v2", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "100" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"custom_fields\": [\n {\n \"default_value\": {},\n \"id\": \"string\",\n \"name\": \"string\",\n \"type\": {\n \"discriminator\": {\n \"description\": \"The discriminator for the model property type. This field is required.\",\n \"value\": \"\"\n },\n \"primitive_type\": {\n \"description\": \"The base primitive type of the custom field. This field is required.\",\n \"value\": \"\"\n },\n \"array\": {\n \"description\": \"The array property type of the custom field. This field is optional.\",\n \"nullable\": true,\n \"value\": \"\"\n },\n \"ref\": {\n \"description\": \"The reference property type of the custom field. This field is optional.\",\n \"nullable\": true,\n \"value\": \"\"\n }\n },\n \"label\": \"string\",\n \"description\": \"string\",\n \"helper_text\": \"string\",\n \"validators\": [\n {\n \"required\": true,\n \"size\": {\n \"description\": \"The size validator for the custom field. This field is required.\",\n \"value\": \"\"\n }\n },\n {\n \"required\": false,\n \"size\": {\n \"description\": \"The size validator for the custom field. This field is required.\",\n \"value\": \"\"\n }\n }\n ],\n \"display_options\": {\n \"hidden\": false,\n \"type\": {\n \"description\": \"The type of display options. This field is required.\",\n \"value\": \"\"\n },\n \"array_display_options\": {\n \"description\": \"The display options for array type custom fields. This field is optional.\",\n \"value\": \"\"\n },\n \"reference_type_display_options\": {\n \"description\": \"The display options for reference type custom fields. This field is optional.\",\n \"value\": \"\"\n },\n \"date_time_display_options\": {\n \"description\": \"The display options for date and time type custom fields. This field is optional.\",\n \"value\": \"\"\n },\n \"boolean_display_options\": {\n \"description\": \"The display options for boolean type custom fields. This field is optional.\",\n \"value\": \"\"\n },\n \"duration\": {\n \"description\": \"The display options for duration type custom fields. This field is optional.\",\n \"value\": \"\"\n }\n },\n \"options\": {\n \"display_type\": {\n \"description\": \"The display type of the custom field options. This field is required.\",\n \"value\": \"\"\n },\n \"groups\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"default_option_id\": \"string\",\n \"option_source\": {\n \"description\": \"The source of the custom field options. This field is optional.\",\n \"nullable\": true,\n \"value\": \"\"\n }\n }\n },\n {\n \"default_value\": {},\n \"id\": \"string\",\n \"name\": \"string\",\n \"type\": {\n \"discriminator\": {\n \"description\": \"The discriminator for the model property type. This field is required.\",\n \"value\": \"\"\n },\n \"primitive_type\": {\n \"description\": \"The base primitive type of the custom field. This field is required.\",\n \"value\": \"\"\n },\n \"array\": {\n \"description\": \"The array property type of the custom field. This field is optional.\",\n \"nullable\": true,\n \"value\": \"\"\n },\n \"ref\": {\n \"description\": \"The reference property type of the custom field. This field is optional.\",\n \"nullable\": true,\n \"value\": \"\"\n }\n },\n \"label\": \"string\",\n \"description\": \"string\",\n \"helper_text\": \"string\",\n \"validators\": [\n {\n \"required\": true,\n \"size\": {\n \"description\": \"The size validator for the custom field. This field is required.\",\n \"value\": \"\"\n }\n },\n {\n \"required\": true,\n \"size\": {\n \"description\": \"The size validator for the custom field. This field is required.\",\n \"value\": \"\"\n }\n }\n ],\n \"display_options\": {\n \"hidden\": false,\n \"type\": {\n \"description\": \"The type of display options. This field is required.\",\n \"value\": \"\"\n },\n \"array_display_options\": {\n \"description\": \"The display options for array type custom fields. This field is optional.\",\n \"value\": \"\"\n },\n \"reference_type_display_options\": {\n \"description\": \"The display options for reference type custom fields. This field is optional.\",\n \"value\": \"\"\n },\n \"date_time_display_options\": {\n \"description\": \"The display options for date and time type custom fields. This field is optional.\",\n \"value\": \"\"\n },\n \"boolean_display_options\": {\n \"description\": \"The display options for boolean type custom fields. This field is optional.\",\n \"value\": \"\"\n },\n \"duration\": {\n \"description\": \"The display options for duration type custom fields. This field is optional.\",\n \"value\": \"\"\n }\n },\n \"options\": {\n \"display_type\": {\n \"description\": \"The display type of the custom field options. This field is required.\",\n \"value\": \"\"\n },\n \"groups\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"default_option_id\": \"string\",\n \"option_source\": {\n \"description\": \"The source of the custom field options. This field is optional.\",\n \"nullable\": true,\n \"value\": \"\"\n }\n }\n }\n ],\n \"next_page_token\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6ec3ab65-8f59-4318-8328-1b9e6f22914b", "name": "Creates a new custom field.", "request": { "name": "Creates a new custom field.", "description": { "content": "Creates a new custom field.", "type": "text/plain" }, "url": { "path": [ "v2", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"ntq\",\n \"type\": {\n \"discriminator\": \"REF\",\n \"primitive_type\": \"INTEGER\",\n \"array\": {\n \"list_type\": {\n \"description\": \"The type of the list contained in the array property. This field is required.\",\n \"value\": \"\"\n }\n },\n \"ref\": {\n \"reference_type\": {\n \"category\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n \"fields\": [\n \"string\",\n \"string\"\n ]\n }\n },\n \"label\": \"string\",\n \"description\": \"string\",\n \"example_value\": {},\n \"helper_text\": \"string\",\n \"default_value\": {},\n \"display_options\": {\n \"hidden\": true,\n \"type\": \"REF\",\n \"array_display_options\": {\n \"item_options\": {\n \"description\": \"Display options for the items in the array. This field is required.\",\n \"value\": \"\"\n },\n \"sortable\": false\n },\n \"reference_type_display_options\": {\n \"hidden\": true,\n \"card_options\": {\n \"card_properties\": {\n \"value\": \"\"\n }\n },\n \"title_property\": \"string\",\n \"description_property\": \"string\",\n \"reference_display_type\": \"CARD\",\n \"empty_state\": {\n \"description\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n },\n \"component_name\": \"string\"\n },\n \"date_time_display_options\": {\n \"allow_past_dates\": true,\n \"allow_future_dates\": false\n },\n \"boolean_display_options\": {\n \"display_type\": \"TOGGLE\"\n },\n \"duration\": {\n \"duration_units\": [\n \"MINUTES\",\n \"HOURS\"\n ]\n }\n },\n \"options\": {\n \"display_type\": \"RADIO\",\n \"groups\": [\n {\n \"options\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"sort_order\": {\n \"value\": \"\"\n },\n \"subtitle\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"sort_order\": {\n \"value\": \"\"\n },\n \"subtitle\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n }\n ],\n \"sort_order\": 1029,\n \"header\": \"string\"\n },\n {\n \"options\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"sort_order\": {\n \"value\": \"\"\n },\n \"subtitle\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"sort_order\": {\n \"value\": \"\"\n },\n \"subtitle\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n }\n ],\n \"sort_order\": 8160,\n \"header\": \"string\"\n }\n ],\n \"default_option_id\": \"string\",\n \"option_source\": {\n \"category\": \"string\",\n \"name\": \"string\"\n }\n },\n \"validators\": [\n {\n \"required\": false,\n \"size\": {\n \"size\": 9908,\n \"size_type\": \"MAX\"\n }\n },\n {\n \"required\": false,\n \"size\": {\n \"size\": 9391,\n \"size_type\": \"MAX\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "788a0e39-58cc-4a6c-8269-e3343ed1ef80", "name": "The created custom field as a PipelineCustomField object.", "originalRequest": { "url": { "path": [ "v2", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"h6Yt\",\n \"type\": {\n \"discriminator\": \"ARRAY\",\n \"primitive_type\": \"PERCENT\",\n \"array\": {\n \"list_type\": {\n \"description\": \"The type of the list contained in the array property. This field is required.\",\n \"value\": \"\"\n }\n },\n \"ref\": {\n \"reference_type\": {\n \"category\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n \"fields\": [\n \"string\",\n \"string\"\n ]\n }\n },\n \"label\": \"string\",\n \"description\": \"string\",\n \"example_value\": {},\n \"helper_text\": \"string\",\n \"default_value\": {},\n \"display_options\": {\n \"hidden\": false,\n \"type\": \"DEFAULT\",\n \"array_display_options\": {\n \"item_options\": {\n \"description\": \"Display options for the items in the array. This field is required.\",\n \"value\": \"\"\n },\n \"sortable\": true\n },\n \"reference_type_display_options\": {\n \"hidden\": false,\n \"card_options\": {\n \"card_properties\": {\n \"value\": \"\"\n }\n },\n \"title_property\": \"string\",\n \"description_property\": \"string\",\n \"reference_display_type\": \"CARD\",\n \"empty_state\": {\n \"description\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n },\n \"component_name\": \"string\"\n },\n \"date_time_display_options\": {\n \"allow_past_dates\": false,\n \"allow_future_dates\": false\n },\n \"boolean_display_options\": {\n \"display_type\": \"RADIO\"\n },\n \"duration\": {\n \"duration_units\": [\n \"YEARS\",\n \"YEARS\"\n ]\n }\n },\n \"options\": {\n \"display_type\": \"RADIO\",\n \"groups\": [\n {\n \"options\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"sort_order\": {\n \"value\": \"\"\n },\n \"subtitle\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"sort_order\": {\n \"value\": \"\"\n },\n \"subtitle\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n }\n ],\n \"sort_order\": 7821,\n \"header\": \"string\"\n },\n {\n \"options\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"sort_order\": {\n \"value\": \"\"\n },\n \"subtitle\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"sort_order\": {\n \"value\": \"\"\n },\n \"subtitle\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n }\n ],\n \"sort_order\": 3142,\n \"header\": \"string\"\n }\n ],\n \"default_option_id\": \"string\",\n \"option_source\": {\n \"category\": \"string\",\n \"name\": \"string\"\n }\n },\n \"validators\": [\n {\n \"required\": false,\n \"size\": {\n \"size\": 6008,\n \"size_type\": \"MIN\"\n }\n },\n {\n \"required\": true,\n \"size\": {\n \"size\": 7110,\n \"size_type\": \"MAX\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"default_value\": {},\n \"id\": \"string\",\n \"name\": \"string\",\n \"type\": {\n \"discriminator\": \"REF\",\n \"primitive_type\": \"DURATION\",\n \"array\": {\n \"list_type\": {\n \"description\": \"The type of the list contained in the array property. This field is required.\",\n \"value\": \"\"\n }\n },\n \"ref\": {\n \"reference_type\": {\n \"category\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n \"fields\": [\n \"string\",\n \"string\"\n ]\n }\n },\n \"label\": \"string\",\n \"description\": \"string\",\n \"helper_text\": \"string\",\n \"validators\": [\n {\n \"required\": true,\n \"size\": {\n \"size\": 5995,\n \"size_type\": \"MIN\"\n }\n },\n {\n \"required\": true,\n \"size\": {\n \"size\": 2204,\n \"size_type\": \"MIN\"\n }\n }\n ],\n \"display_options\": {\n \"hidden\": true,\n \"type\": \"ARRAY\",\n \"array_display_options\": {\n \"item_options\": {\n \"description\": \"Display options for the items in the array. This field is required.\",\n \"value\": \"\"\n },\n \"sortable\": true\n },\n \"reference_type_display_options\": {\n \"hidden\": true,\n \"card_options\": {\n \"card_properties\": {\n \"value\": \"\"\n }\n },\n \"title_property\": \"string\",\n \"description_property\": \"string\",\n \"reference_display_type\": \"DROPDOWN\",\n \"empty_state\": {\n \"description\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n },\n \"component_name\": \"string\"\n },\n \"date_time_display_options\": {\n \"allow_past_dates\": true,\n \"allow_future_dates\": false\n },\n \"boolean_display_options\": {\n \"display_type\": \"TOGGLE\"\n },\n \"duration\": {\n \"duration_units\": [\n \"DAYS\",\n \"MONTHS\"\n ]\n }\n },\n \"options\": {\n \"display_type\": \"DROPDOWN\",\n \"groups\": [\n {\n \"options\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"sort_order\": {\n \"value\": \"\"\n },\n \"subtitle\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"sort_order\": {\n \"value\": \"\"\n },\n \"subtitle\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n }\n ],\n \"sort_order\": 6398,\n \"header\": \"string\"\n },\n {\n \"options\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"sort_order\": {\n \"value\": \"\"\n },\n \"subtitle\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"sort_order\": {\n \"value\": \"\"\n },\n \"subtitle\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n }\n ],\n \"sort_order\": 995,\n \"header\": \"string\"\n }\n ],\n \"default_option_id\": \"string\",\n \"option_source\": {\n \"category\": \"string\",\n \"name\": \"string\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b28eb8c1-d94f-43b8-ab11-d2c5b2913cee", "name": "Deletes a custom field", "request": { "name": "Deletes a custom field", "description": { "content": "Deletes a custom field", "type": "text/plain" }, "url": { "path": [ "v2", "customFields", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the identifier of the custom field to delete" } ] }, "method": "DELETE", "auth": null }, "response": [ { "id": "95abf854-0785-483f-ae33-13f999153926", "name": "deletePipelineCustomField 204 response", "originalRequest": { "url": { "path": [ "v2", "customFields", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the identifier of the custom field to delete" } ] }, "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "01168d5a-1979-4e0d-aaa1-38014b7b0a44", "name": "Updates a custom field", "request": { "name": "Updates a custom field", "description": { "content": "Updates a custom field", "type": "text/plain" }, "url": { "path": [ "v2", "customFields", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the identifier of the custom field to update" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"label\": \"string\",\n \"description\": \"string\",\n \"hint\": \"string\",\n \"helper_text\": \"string\",\n \"default_value\": {},\n \"display_options\": {\n \"hidden\": true,\n \"type\": \"DURATION\",\n \"array_display_options\": {\n \"item_options\": {\n \"description\": \"Display options for the items in the array. This field is required.\",\n \"value\": \"\"\n },\n \"sortable\": true\n },\n \"reference_type_display_options\": {\n \"hidden\": true,\n \"card_options\": {\n \"card_properties\": {\n \"value\": \"\"\n }\n },\n \"title_property\": \"string\",\n \"description_property\": \"string\",\n \"reference_display_type\": \"CARD\",\n \"empty_state\": {\n \"description\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n },\n \"component_name\": \"string\"\n },\n \"date_time_display_options\": {\n \"allow_past_dates\": false,\n \"allow_future_dates\": false\n },\n \"boolean_display_options\": {\n \"display_type\": \"TOGGLE\"\n },\n \"duration\": {\n \"duration_units\": [\n \"MINUTES\",\n \"HOURS\"\n ]\n }\n },\n \"options\": {\n \"display_type\": \"DROPDOWN\",\n \"groups\": [\n {\n \"options\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"sort_order\": {\n \"value\": \"\"\n },\n \"subtitle\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"sort_order\": {\n \"value\": \"\"\n },\n \"subtitle\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n }\n ],\n \"sort_order\": 4535,\n \"header\": \"string\"\n },\n {\n \"options\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"sort_order\": {\n \"value\": \"\"\n },\n \"subtitle\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"sort_order\": {\n \"value\": \"\"\n },\n \"subtitle\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n }\n ],\n \"sort_order\": 6773,\n \"header\": \"string\"\n }\n ],\n \"default_option_id\": \"string\",\n \"option_source\": {\n \"category\": \"string\",\n \"name\": \"string\"\n }\n },\n \"validators\": [\n {\n \"required\": true,\n \"size\": {\n \"size\": 5278,\n \"size_type\": \"MAX\"\n }\n },\n {\n \"required\": false,\n \"size\": {\n \"size\": 2169,\n \"size_type\": \"MIN\"\n }\n }\n ],\n \"deleted\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "bfa40045-94bb-4c6b-a004-0bb6e388b4ec", "name": "the updated PipelineCustomField", "originalRequest": { "url": { "path": [ "v2", "customFields", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the identifier of the custom field to update" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"label\": \"string\",\n \"description\": \"string\",\n \"hint\": \"string\",\n \"helper_text\": \"string\",\n \"default_value\": {},\n \"display_options\": {\n \"hidden\": true,\n \"type\": \"DURATION\",\n \"array_display_options\": {\n \"item_options\": {\n \"description\": \"Display options for the items in the array. This field is required.\",\n \"value\": \"\"\n },\n \"sortable\": false\n },\n \"reference_type_display_options\": {\n \"hidden\": false,\n \"card_options\": {\n \"card_properties\": {\n \"value\": \"\"\n }\n },\n \"title_property\": \"string\",\n \"description_property\": \"string\",\n \"reference_display_type\": \"DROPDOWN\",\n \"empty_state\": {\n \"description\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n },\n \"component_name\": \"string\"\n },\n \"date_time_display_options\": {\n \"allow_past_dates\": true,\n \"allow_future_dates\": true\n },\n \"boolean_display_options\": {\n \"display_type\": \"TOGGLE_BUTTON\"\n },\n \"duration\": {\n \"duration_units\": [\n \"MINUTES\",\n \"MONTHS\"\n ]\n }\n },\n \"options\": {\n \"display_type\": \"CHECKBOX\",\n \"groups\": [\n {\n \"options\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"sort_order\": {\n \"value\": \"\"\n },\n \"subtitle\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"sort_order\": {\n \"value\": \"\"\n },\n \"subtitle\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n }\n ],\n \"sort_order\": 6783,\n \"header\": \"string\"\n },\n {\n \"options\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"sort_order\": {\n \"value\": \"\"\n },\n \"subtitle\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"sort_order\": {\n \"value\": \"\"\n },\n \"subtitle\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n }\n ],\n \"sort_order\": 3165,\n \"header\": \"string\"\n }\n ],\n \"default_option_id\": \"string\",\n \"option_source\": {\n \"category\": \"string\",\n \"name\": \"string\"\n }\n },\n \"validators\": [\n {\n \"required\": true,\n \"size\": {\n \"size\": 5927,\n \"size_type\": \"MIN\"\n }\n },\n {\n \"required\": true,\n \"size\": {\n \"size\": 3334,\n \"size_type\": \"MAX\"\n }\n }\n ],\n \"deleted\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"default_value\": {},\n \"id\": \"string\",\n \"name\": \"string\",\n \"type\": {\n \"discriminator\": \"REF\",\n \"primitive_type\": \"DURATION\",\n \"array\": {\n \"list_type\": {\n \"description\": \"The type of the list contained in the array property. This field is required.\",\n \"value\": \"\"\n }\n },\n \"ref\": {\n \"reference_type\": {\n \"category\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n \"fields\": [\n \"string\",\n \"string\"\n ]\n }\n },\n \"label\": \"string\",\n \"description\": \"string\",\n \"helper_text\": \"string\",\n \"validators\": [\n {\n \"required\": true,\n \"size\": {\n \"size\": 5995,\n \"size_type\": \"MIN\"\n }\n },\n {\n \"required\": true,\n \"size\": {\n \"size\": 2204,\n \"size_type\": \"MIN\"\n }\n }\n ],\n \"display_options\": {\n \"hidden\": true,\n \"type\": \"ARRAY\",\n \"array_display_options\": {\n \"item_options\": {\n \"description\": \"Display options for the items in the array. This field is required.\",\n \"value\": \"\"\n },\n \"sortable\": true\n },\n \"reference_type_display_options\": {\n \"hidden\": true,\n \"card_options\": {\n \"card_properties\": {\n \"value\": \"\"\n }\n },\n \"title_property\": \"string\",\n \"description_property\": \"string\",\n \"reference_display_type\": \"DROPDOWN\",\n \"empty_state\": {\n \"description\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n },\n \"component_name\": \"string\"\n },\n \"date_time_display_options\": {\n \"allow_past_dates\": true,\n \"allow_future_dates\": false\n },\n \"boolean_display_options\": {\n \"display_type\": \"TOGGLE\"\n },\n \"duration\": {\n \"duration_units\": [\n \"DAYS\",\n \"MONTHS\"\n ]\n }\n },\n \"options\": {\n \"display_type\": \"DROPDOWN\",\n \"groups\": [\n {\n \"options\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"sort_order\": {\n \"value\": \"\"\n },\n \"subtitle\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"sort_order\": {\n \"value\": \"\"\n },\n \"subtitle\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n }\n ],\n \"sort_order\": 6398,\n \"header\": \"string\"\n },\n {\n \"options\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"sort_order\": {\n \"value\": \"\"\n },\n \"subtitle\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"sort_order\": {\n \"value\": \"\"\n },\n \"subtitle\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n }\n ],\n \"sort_order\": 995,\n \"header\": \"string\"\n }\n ],\n \"default_option_id\": \"string\",\n \"option_source\": {\n \"category\": \"string\",\n \"name\": \"string\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "ee4304a0-1754-4126-b559-2119a16ef74e", "name": "Deals Date Expression", "description": { "content": "Deals Date Expression endpoints.", "type": "text/plain" }, "item": [ { "id": "4d59845f-0425-4b2d-a4fa-02de1c9d4228", "name": "query Date Expressions", "request": { "name": "query Date Expressions", "description": {}, "url": { "path": [ "v2", "dateExpressions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "time_zone", "value": "string" }, { "disabled": false, "key": "query", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "c3172ed2-39c9-4b3b-9b97-fab4d03b568f", "name": "queryDateExpressions 200 response", "originalRequest": { "url": { "path": [ "v2", "dateExpressions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "time_zone", "value": "string" }, { "key": "query", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"results\": [\n {\n \"date_inferred\": true,\n \"parse_end\": 2049,\n \"parse_start\": 4016,\n \"query\": \"string\",\n \"recurring\": false,\n \"recurse_until\": {\n \"dates\": [\n \"1999-02-17T01:19:17.628Z\",\n \"2025-06-21T21:10:53.465Z\"\n ],\n \"chain\": \"string\"\n },\n \"result\": {\n \"dates\": [\n \"1956-12-23T08:10:06.243Z\",\n \"1972-05-15T06:29:38.863Z\"\n ],\n \"chain\": \"string\"\n },\n \"time_inferred\": true,\n \"complete_match\": true\n },\n {\n \"date_inferred\": false,\n \"parse_end\": 6107,\n \"parse_start\": 6640,\n \"query\": \"string\",\n \"recurring\": true,\n \"recurse_until\": {\n \"dates\": [\n \"1989-09-25T16:10:07.756Z\",\n \"2000-10-30T16:00:20.419Z\"\n ],\n \"chain\": \"string\"\n },\n \"result\": {\n \"dates\": [\n \"1968-03-09T09:44:02.305Z\",\n \"2022-05-22T14:30:28.211Z\"\n ],\n \"chain\": \"string\"\n },\n \"time_inferred\": false,\n \"complete_match\": false\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "13b4ed1c-2143-43ea-93ed-51149df9ac54", "name": "Deals Display Forms", "description": { "content": "Deals Display Forms endpoints.", "type": "text/plain" }, "item": [ { "id": "e5db762b-91a0-469e-93ec-403a393b01d0", "name": "Retrieves a specific display form by a pipeline ID.", "request": { "name": "Retrieves a specific display form by a pipeline ID.", "description": { "content": "Retrieves a specific display form by a pipeline ID.", "type": "text/plain" }, "url": { "path": [ "v2", "pipelines", ":id", "form" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the ID of the pipeline containing the form" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "3d8ec83e-46e8-4d7c-aa22-6a1d0ec5c515", "name": "the requested Deal", "originalRequest": { "url": { "path": [ "v2", "pipelines", ":id", "form" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the ID of the pipeline containing the form" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"groups\": [\n {\n \"id\": \"string\",\n \"sort_order\": 4777,\n \"title\": \"string\",\n \"description\": \"string\",\n \"properties\": [\n {\n \"id\": \"string\",\n \"property\": {\n \"default_value\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"label\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"helper_text\": {\n \"value\": \"\"\n },\n \"validators\": {\n \"value\": \"\"\n },\n \"display_options\": {\n \"value\": \"\"\n },\n \"options\": {\n \"value\": \"\"\n }\n },\n \"source\": \"SYSTEM\",\n \"system_field_record\": \"string\",\n \"system_field_id\": \"string\",\n \"label\": \"string\",\n \"description\": \"string\",\n \"helper_text\": \"string\",\n \"default_value\": {},\n \"display_options\": {\n \"hidden\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"array_display_options\": {\n \"value\": \"\"\n },\n \"reference_type_display_options\": {\n \"value\": \"\"\n },\n \"date_time_display_options\": {\n \"value\": \"\"\n },\n \"boolean_display_options\": {\n \"value\": \"\"\n },\n \"duration\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"id\": \"string\",\n \"property\": {\n \"default_value\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"label\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"helper_text\": {\n \"value\": \"\"\n },\n \"validators\": {\n \"value\": \"\"\n },\n \"display_options\": {\n \"value\": \"\"\n },\n \"options\": {\n \"value\": \"\"\n }\n },\n \"source\": \"SYSTEM\",\n \"system_field_record\": \"string\",\n \"system_field_id\": \"string\",\n \"label\": \"string\",\n \"description\": \"string\",\n \"helper_text\": \"string\",\n \"default_value\": {},\n \"display_options\": {\n \"hidden\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"array_display_options\": {\n \"value\": \"\"\n },\n \"reference_type_display_options\": {\n \"value\": \"\"\n },\n \"date_time_display_options\": {\n \"value\": \"\"\n },\n \"boolean_display_options\": {\n \"value\": \"\"\n },\n \"duration\": {\n \"value\": \"\"\n }\n }\n }\n ]\n },\n {\n \"id\": \"string\",\n \"sort_order\": 5112,\n \"title\": \"string\",\n \"description\": \"string\",\n \"properties\": [\n {\n \"id\": \"string\",\n \"property\": {\n \"default_value\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"label\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"helper_text\": {\n \"value\": \"\"\n },\n \"validators\": {\n \"value\": \"\"\n },\n \"display_options\": {\n \"value\": \"\"\n },\n \"options\": {\n \"value\": \"\"\n }\n },\n \"source\": \"CUSTOM\",\n \"system_field_record\": \"string\",\n \"system_field_id\": \"string\",\n \"label\": \"string\",\n \"description\": \"string\",\n \"helper_text\": \"string\",\n \"default_value\": {},\n \"display_options\": {\n \"hidden\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"array_display_options\": {\n \"value\": \"\"\n },\n \"reference_type_display_options\": {\n \"value\": \"\"\n },\n \"date_time_display_options\": {\n \"value\": \"\"\n },\n \"boolean_display_options\": {\n \"value\": \"\"\n },\n \"duration\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"id\": \"string\",\n \"property\": {\n \"default_value\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"label\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"helper_text\": {\n \"value\": \"\"\n },\n \"validators\": {\n \"value\": \"\"\n },\n \"display_options\": {\n \"value\": \"\"\n },\n \"options\": {\n \"value\": \"\"\n }\n },\n \"source\": \"CUSTOM\",\n \"system_field_record\": \"string\",\n \"system_field_id\": \"string\",\n \"label\": \"string\",\n \"description\": \"string\",\n \"helper_text\": \"string\",\n \"default_value\": {},\n \"display_options\": {\n \"hidden\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"array_display_options\": {\n \"value\": \"\"\n },\n \"reference_type_display_options\": {\n \"value\": \"\"\n },\n \"date_time_display_options\": {\n \"value\": \"\"\n },\n \"boolean_display_options\": {\n \"value\": \"\"\n },\n \"duration\": {\n \"value\": \"\"\n }\n }\n }\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f69df42e-bc32-4e7d-8bf7-d93e44fdff80", "name": "Updates a display form", "request": { "name": "Updates a display form", "description": { "content": "Updates a display form", "type": "text/plain" }, "url": { "path": [ "v2", "pipelines", ":id", "form" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the ID of the pipeline containing the form" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"groups\": [\n {\n \"properties\": [\n {\n \"source\": \"SYSTEM\",\n \"sort_order\": 525,\n \"id\": \"string\",\n \"system_field_record\": \"string\",\n \"system_field_id\": \"string\",\n \"label\": \"string\",\n \"description\": \"string\",\n \"helper_text\": \"string\",\n \"default_value\": {},\n \"display_options\": {\n \"hidden\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"array_display_options\": {\n \"value\": \"\"\n },\n \"reference_type_display_options\": {\n \"value\": \"\"\n },\n \"date_time_display_options\": {\n \"value\": \"\"\n },\n \"boolean_display_options\": {\n \"value\": \"\"\n },\n \"duration\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"source\": \"CUSTOM\",\n \"sort_order\": 5154,\n \"id\": \"string\",\n \"system_field_record\": \"string\",\n \"system_field_id\": \"string\",\n \"label\": \"string\",\n \"description\": \"string\",\n \"helper_text\": \"string\",\n \"default_value\": {},\n \"display_options\": {\n \"hidden\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"array_display_options\": {\n \"value\": \"\"\n },\n \"reference_type_display_options\": {\n \"value\": \"\"\n },\n \"date_time_display_options\": {\n \"value\": \"\"\n },\n \"boolean_display_options\": {\n \"value\": \"\"\n },\n \"duration\": {\n \"value\": \"\"\n }\n }\n }\n ],\n \"title\": \"string\",\n \"sort_order\": 190,\n \"description\": \"string\"\n },\n {\n \"properties\": [\n {\n \"source\": \"CUSTOM\",\n \"sort_order\": 1929,\n \"id\": \"string\",\n \"system_field_record\": \"string\",\n \"system_field_id\": \"string\",\n \"label\": \"string\",\n \"description\": \"string\",\n \"helper_text\": \"string\",\n \"default_value\": {},\n \"display_options\": {\n \"hidden\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"array_display_options\": {\n \"value\": \"\"\n },\n \"reference_type_display_options\": {\n \"value\": \"\"\n },\n \"date_time_display_options\": {\n \"value\": \"\"\n },\n \"boolean_display_options\": {\n \"value\": \"\"\n },\n \"duration\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"source\": \"CUSTOM\",\n \"sort_order\": 7481,\n \"id\": \"string\",\n \"system_field_record\": \"string\",\n \"system_field_id\": \"string\",\n \"label\": \"string\",\n \"description\": \"string\",\n \"helper_text\": \"string\",\n \"default_value\": {},\n \"display_options\": {\n \"hidden\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"array_display_options\": {\n \"value\": \"\"\n },\n \"reference_type_display_options\": {\n \"value\": \"\"\n },\n \"date_time_display_options\": {\n \"value\": \"\"\n },\n \"boolean_display_options\": {\n \"value\": \"\"\n },\n \"duration\": {\n \"value\": \"\"\n }\n }\n }\n ],\n \"title\": \"string\",\n \"sort_order\": 4216,\n \"description\": \"string\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "e2b067b8-66ba-4a05-ae7d-e30f5fb30406", "name": "the updated DisplayForm", "originalRequest": { "url": { "path": [ "v2", "pipelines", ":id", "form" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the ID of the pipeline containing the form" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"groups\": [\n {\n \"properties\": [\n {\n \"source\": \"SYSTEM\",\n \"sort_order\": 8876,\n \"id\": \"string\",\n \"system_field_record\": \"string\",\n \"system_field_id\": \"string\",\n \"label\": \"string\",\n \"description\": \"string\",\n \"helper_text\": \"string\",\n \"default_value\": {},\n \"display_options\": {\n \"hidden\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"array_display_options\": {\n \"value\": \"\"\n },\n \"reference_type_display_options\": {\n \"value\": \"\"\n },\n \"date_time_display_options\": {\n \"value\": \"\"\n },\n \"boolean_display_options\": {\n \"value\": \"\"\n },\n \"duration\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"source\": \"CUSTOM\",\n \"sort_order\": 9663,\n \"id\": \"string\",\n \"system_field_record\": \"string\",\n \"system_field_id\": \"string\",\n \"label\": \"string\",\n \"description\": \"string\",\n \"helper_text\": \"string\",\n \"default_value\": {},\n \"display_options\": {\n \"hidden\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"array_display_options\": {\n \"value\": \"\"\n },\n \"reference_type_display_options\": {\n \"value\": \"\"\n },\n \"date_time_display_options\": {\n \"value\": \"\"\n },\n \"boolean_display_options\": {\n \"value\": \"\"\n },\n \"duration\": {\n \"value\": \"\"\n }\n }\n }\n ],\n \"title\": \"string\",\n \"sort_order\": 1127,\n \"description\": \"string\"\n },\n {\n \"properties\": [\n {\n \"source\": \"CUSTOM\",\n \"sort_order\": 9096,\n \"id\": \"string\",\n \"system_field_record\": \"string\",\n \"system_field_id\": \"string\",\n \"label\": \"string\",\n \"description\": \"string\",\n \"helper_text\": \"string\",\n \"default_value\": {},\n \"display_options\": {\n \"hidden\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"array_display_options\": {\n \"value\": \"\"\n },\n \"reference_type_display_options\": {\n \"value\": \"\"\n },\n \"date_time_display_options\": {\n \"value\": \"\"\n },\n \"boolean_display_options\": {\n \"value\": \"\"\n },\n \"duration\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"source\": \"SYSTEM\",\n \"sort_order\": 9261,\n \"id\": \"string\",\n \"system_field_record\": \"string\",\n \"system_field_id\": \"string\",\n \"label\": \"string\",\n \"description\": \"string\",\n \"helper_text\": \"string\",\n \"default_value\": {},\n \"display_options\": {\n \"hidden\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"array_display_options\": {\n \"value\": \"\"\n },\n \"reference_type_display_options\": {\n \"value\": \"\"\n },\n \"date_time_display_options\": {\n \"value\": \"\"\n },\n \"boolean_display_options\": {\n \"value\": \"\"\n },\n \"duration\": {\n \"value\": \"\"\n }\n }\n }\n ],\n \"title\": \"string\",\n \"sort_order\": 4607,\n \"description\": \"string\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"groups\": [\n {\n \"id\": \"string\",\n \"sort_order\": 3325,\n \"title\": \"string\",\n \"description\": \"string\",\n \"properties\": [\n {\n \"id\": \"string\",\n \"property\": {\n \"default_value\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"label\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"helper_text\": {\n \"value\": \"\"\n },\n \"validators\": {\n \"value\": \"\"\n },\n \"display_options\": {\n \"value\": \"\"\n },\n \"options\": {\n \"value\": \"\"\n }\n },\n \"source\": \"CUSTOM\",\n \"system_field_record\": \"string\",\n \"system_field_id\": \"string\",\n \"label\": \"string\",\n \"description\": \"string\",\n \"helper_text\": \"string\",\n \"default_value\": {},\n \"display_options\": {\n \"hidden\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"array_display_options\": {\n \"value\": \"\"\n },\n \"reference_type_display_options\": {\n \"value\": \"\"\n },\n \"date_time_display_options\": {\n \"value\": \"\"\n },\n \"boolean_display_options\": {\n \"value\": \"\"\n },\n \"duration\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"id\": \"string\",\n \"property\": {\n \"default_value\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"label\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"helper_text\": {\n \"value\": \"\"\n },\n \"validators\": {\n \"value\": \"\"\n },\n \"display_options\": {\n \"value\": \"\"\n },\n \"options\": {\n \"value\": \"\"\n }\n },\n \"source\": \"CUSTOM\",\n \"system_field_record\": \"string\",\n \"system_field_id\": \"string\",\n \"label\": \"string\",\n \"description\": \"string\",\n \"helper_text\": \"string\",\n \"default_value\": {},\n \"display_options\": {\n \"hidden\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"array_display_options\": {\n \"value\": \"\"\n },\n \"reference_type_display_options\": {\n \"value\": \"\"\n },\n \"date_time_display_options\": {\n \"value\": \"\"\n },\n \"boolean_display_options\": {\n \"value\": \"\"\n },\n \"duration\": {\n \"value\": \"\"\n }\n }\n }\n ]\n },\n {\n \"id\": \"string\",\n \"sort_order\": 8805,\n \"title\": \"string\",\n \"description\": \"string\",\n \"properties\": [\n {\n \"id\": \"string\",\n \"property\": {\n \"default_value\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"label\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"helper_text\": {\n \"value\": \"\"\n },\n \"validators\": {\n \"value\": \"\"\n },\n \"display_options\": {\n \"value\": \"\"\n },\n \"options\": {\n \"value\": \"\"\n }\n },\n \"source\": \"CUSTOM\",\n \"system_field_record\": \"string\",\n \"system_field_id\": \"string\",\n \"label\": \"string\",\n \"description\": \"string\",\n \"helper_text\": \"string\",\n \"default_value\": {},\n \"display_options\": {\n \"hidden\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"array_display_options\": {\n \"value\": \"\"\n },\n \"reference_type_display_options\": {\n \"value\": \"\"\n },\n \"date_time_display_options\": {\n \"value\": \"\"\n },\n \"boolean_display_options\": {\n \"value\": \"\"\n },\n \"duration\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"id\": \"string\",\n \"property\": {\n \"default_value\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"label\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"helper_text\": {\n \"value\": \"\"\n },\n \"validators\": {\n \"value\": \"\"\n },\n \"display_options\": {\n \"value\": \"\"\n },\n \"options\": {\n \"value\": \"\"\n }\n },\n \"source\": \"CUSTOM\",\n \"system_field_record\": \"string\",\n \"system_field_id\": \"string\",\n \"label\": \"string\",\n \"description\": \"string\",\n \"helper_text\": \"string\",\n \"default_value\": {},\n \"display_options\": {\n \"hidden\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"array_display_options\": {\n \"value\": \"\"\n },\n \"reference_type_display_options\": {\n \"value\": \"\"\n },\n \"date_time_display_options\": {\n \"value\": \"\"\n },\n \"boolean_display_options\": {\n \"value\": \"\"\n },\n \"duration\": {\n \"value\": \"\"\n }\n }\n }\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "7d27bb50-87c1-43f8-a547-70e2ef348940", "name": "Deals Pipelines", "description": { "content": "Deals Pipelines endpoints.", "type": "text/plain" }, "item": [ { "id": "f72a18d3-722f-4874-89ac-cc43501075d6", "name": "List Pipeline", "request": { "name": "List Pipeline", "description": { "content": "Lists entities based on the provided ListCommand.", "type": "text/plain" }, "url": { "path": [ "v2", "pipelines" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "filter", "value": "string" }, { "disabled": false, "key": "page_token", "value": "string" }, { "disabled": false, "key": "order_by", "value": "string" }, { "disabled": false, "key": "page_size", "value": "100" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "9be59c2a-ee72-43d4-99e3-bfcb5bba2a12", "name": "a response containing the list of entities", "originalRequest": { "url": { "path": [ "v2", "pipelines" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "100" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"next_page_token\": \"string\",\n \"pipelines\": [\n {\n \"id\": \"string\",\n \"name\": \"string\"\n },\n {\n \"id\": \"string\",\n \"name\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2b3d8a5c-dc7a-40d0-8d3d-bf2237cc68d6", "name": "Create Pipeline", "request": { "name": "Create Pipeline", "description": { "content": "Creates a new entity.", "type": "text/plain" }, "url": { "path": [ "v2", "pipelines" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"stages\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "723003d0-a782-43a4-a06e-fc63acd87dfd", "name": "The created entity", "originalRequest": { "url": { "path": [ "v2", "pipelines" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"stages\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a253837a-8612-4488-a9aa-1fcf02064fe2", "name": "Retrieves a list of pipeline summaries.", "request": { "name": "Retrieves a list of pipeline summaries.", "description": { "content": "Retrieves a list of pipeline summaries.", "type": "text/plain" }, "url": { "path": [ "v2", "pipelines", "summaries" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "filter", "value": "string" }, { "disabled": false, "key": "page_size", "value": "100" }, { "disabled": false, "key": "page_token", "value": "string" }, { "disabled": false, "key": "order_by", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "ed1fae75-9fae-42fe-8e1d-8a4d15399b4a", "name": "the response containing the list of pipeline summaries and the next page token", "originalRequest": { "url": { "path": [ "v2", "pipelines", "summaries" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_size", "value": "100" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"next_page_token\": \"string\",\n \"pipeline_summaries\": [\n {\n \"pipeline_name\": \"string\",\n \"pipeline_id\": \"502\",\n \"stat_total_deal_count\": 8979,\n \"stat_new_deal_count\": 4088\n },\n {\n \"pipeline_name\": \"string\",\n \"pipeline_id\": \"6\",\n \"stat_total_deal_count\": 2196,\n \"stat_new_deal_count\": 6671\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e81c547e-d2fb-4d81-83fe-5681d90b49de", "name": "Get Pipeline", "request": { "name": "Get Pipeline", "description": { "content": "Retrieves an entity by its identifier.", "type": "text/plain" }, "url": { "path": [ "v2", "pipelines", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the entity identifier" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "6fa366ae-f72c-4c59-936c-95dcb3fe2599", "name": "The retrieved entity", "originalRequest": { "url": { "path": [ "v2", "pipelines", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the entity identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cef9f992-23bb-45e4-8db9-2ac74cb1bb06", "name": "Deletes a pipeline.", "request": { "name": "Deletes a pipeline.", "description": { "content": "Deletes a pipeline.", "type": "text/plain" }, "url": { "path": [ "v2", "pipelines", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "new_stage_id", "value": "string", "description": "the new stage identifier, can be null" }, { "disabled": false, "key": "allow_cleanup", "value": "false", "description": "flag indicating whether cleanup is allowed, can be null" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the pipeline identifier" } ] }, "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "45d35da9-9a73-41a2-8c19-6ac84e8a53d3", "name": "A response indicating no content", "originalRequest": { "url": { "path": [ "v2", "pipelines", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "new_stage_id", "value": "string" }, { "key": "allow_cleanup", "value": "true" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the pipeline identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7897518f-020a-44aa-84cd-38a7e831e214", "name": "Update Pipeline", "request": { "name": "Update Pipeline", "description": { "content": "Updates an existing entity.", "type": "text/plain" }, "url": { "path": [ "v2", "pipelines", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "update_mask", "value": "string", "description": "(Required) the fields to update" }, { "disabled": false, "key": "update_mask", "value": "string", "description": "(Required) the fields to update" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the entity identifier" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "428de497-9c7d-4bf4-9f10-8ff51f526294", "name": "The updated entity", "originalRequest": { "url": { "path": [ "v2", "pipelines", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "string" }, { "key": "update_mask", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the entity identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cb00ff62-161a-488d-bc6b-396847935bcb", "name": "Updates a pipeline's deals in bulk.", "request": { "name": "Updates a pipeline's deals in bulk.", "description": { "content": "Updates a pipeline's deals in bulk.", "type": "text/plain" }, "url": { "path": [ "v2", "pipelines", ":id", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the pipeline ID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"bulk_deal_update_type\": \"string\",\n \"exclude_deal_ids_specified\": false,\n \"filters\": [\n {\n \"key\": \"string\",\n \"operator\": \"NOT_EQUALS\",\n \"value\": \"string\"\n },\n {\n \"key\": \"string\",\n \"operator\": \"EQUALS\",\n \"value\": \"string\"\n }\n ],\n \"new_value\": \"string\",\n \"deal_ids\": [\n \"string\",\n \"string\",\n \"string\",\n \"string\",\n \"string\",\n \"string\",\n \"string\",\n \"string\",\n \"string\",\n \"string\",\n \"string\",\n \"string\",\n \"string\",\n \"string\",\n \"string\",\n \"string\",\n \"string\",\n \"string\",\n \"string\",\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "3d3ecc3d-3d1c-4fb1-bd4b-46c8bd79e2eb", "name": "the response containing the results of the bulk update operation", "originalRequest": { "url": { "path": [ "v2", "pipelines", ":id", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the pipeline ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"bulk_deal_update_type\": \"string\",\n \"exclude_deal_ids_specified\": false,\n \"filters\": [\n {\n \"key\": \"string\",\n \"operator\": \"EXCLUDES_ANY\",\n \"value\": \"string\"\n },\n {\n \"key\": \"string\",\n \"operator\": \"NOT_EQUALS\",\n \"value\": \"string\"\n }\n ],\n \"new_value\": \"string\",\n \"deal_ids\": [\n \"string\",\n \"string\",\n \"string\",\n \"string\",\n \"string\",\n \"string\",\n \"string\",\n \"string\",\n \"string\",\n \"string\",\n \"string\",\n \"string\",\n \"string\",\n \"string\",\n \"string\",\n \"string\",\n \"string\",\n \"string\",\n \"string\",\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"stage_move_success\": true,\n \"error_message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "67b262b9-9125-4383-9b1b-255d023bdc6e", "name": "Retrieves the list of deals for a specific pipeline.", "request": { "name": "Retrieves the list of deals for a specific pipeline.", "description": { "content": "Retrieves the list of deals for a specific pipeline.", "type": "text/plain" }, "url": { "path": [ "v2", "pipelines", ":id", "deals" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "filter", "value": "string" }, { "disabled": false, "key": "page_size", "value": "100" }, { "disabled": false, "key": "page_token", "value": "string" }, { "disabled": false, "key": "order_by", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the pipeline identifier" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "5e595093-97ad-4b41-8dba-c9b367703725", "name": "a Mono emitting the count of deals", "originalRequest": { "url": { "path": [ "v2", "pipelines", ":id", "deals" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_size", "value": "100" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the pipeline identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"next_page_token\": \"string\",\n \"deals\": [\n {\n \"name\": \"string\",\n \"id\": \"string\",\n \"value\": {\n \"amount\": 8013.4733082170405,\n \"currency\": \"string\"\n },\n \"stage_id\": \"string\",\n \"stage_name\": \"string\",\n \"stage_assignment_time\": \"1948-01-20T20:42:33.533Z\",\n \"close_time\": \"2022-03-11T08:15:37.125Z\",\n \"estimated_close_time\": \"1998-07-25T10:46:38.259Z\",\n \"contact_ids\": [\n \"string\",\n \"string\"\n ],\n \"owner_ids\": [\n \"string\",\n \"string\"\n ],\n \"task_ids\": [\n \"string\",\n \"string\"\n ],\n \"status\": \"ACTIVE\",\n \"order\": \"string\"\n },\n {\n \"name\": \"string\",\n \"id\": \"string\",\n \"value\": {\n \"amount\": 5285.133693617286,\n \"currency\": \"string\"\n },\n \"stage_id\": \"string\",\n \"stage_name\": \"string\",\n \"stage_assignment_time\": \"2021-04-18T04:51:20.883Z\",\n \"close_time\": \"1960-07-14T01:27:28.177Z\",\n \"estimated_close_time\": \"1967-08-14T10:54:02.334Z\",\n \"contact_ids\": [\n \"string\",\n \"string\"\n ],\n \"owner_ids\": [\n \"string\",\n \"string\"\n ],\n \"task_ids\": [\n \"string\",\n \"string\"\n ],\n \"status\": \"LOST\",\n \"order\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "13e1b361-e447-497b-8417-a7be67692438", "name": "Gets the outcome labels for a pipeline.", "request": { "name": "Gets the outcome labels for a pipeline.", "description": { "content": "Gets the outcome labels for a pipeline.", "type": "text/plain" }, "url": { "path": [ "v2", "pipelines", ":id", "outcomes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "filter", "value": "string" }, { "disabled": false, "key": "page_size", "value": "100" }, { "disabled": false, "key": "page_token", "value": "string" }, { "disabled": false, "key": "order_by", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the pipeline identifier" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "6277a5b3-0f3f-42c6-80bb-4b8f1e7ddda5", "name": "the updated list of the pipeline's outcome labels", "originalRequest": { "url": { "path": [ "v2", "pipelines", ":id", "outcomes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_size", "value": "100" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the pipeline identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"next_page_token\": \"string\",\n \"outcome_labels\": [\n {\n \"value\": \"WON\",\n \"label\": \"string\"\n },\n {\n \"value\": \"WON\",\n \"label\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7dcb0c48-333e-43db-8335-596114758edb", "name": "Sets the outcome labels for a pipeline.", "request": { "name": "Sets the outcome labels for a pipeline.", "description": { "content": "Sets the outcome labels for a pipeline.", "type": "text/plain" }, "url": { "path": [ "v2", "pipelines", ":id", "outcomes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the pipeline identifier" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"outcome_labels\": [\n {\n \"value\": \"LOST\",\n \"label\": \"strin\"\n },\n {\n \"value\": \"ACTIVE\",\n \"label\": \"string\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "d87be7b9-dbe3-439b-a0a8-073cc06f6436", "name": "the updated list of the pipeline's outcome labels", "originalRequest": { "url": { "path": [ "v2", "pipelines", ":id", "outcomes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the pipeline identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"outcome_labels\": [\n {\n \"value\": \"ACTIVE\",\n \"label\": \"st\"\n },\n {\n \"value\": \"LOST\",\n \"label\": \"string\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"next_page_token\": \"string\",\n \"outcome_labels\": [\n {\n \"value\": \"LOST\",\n \"label\": \"string\"\n },\n {\n \"value\": \"WON\",\n \"label\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6ba6a068-2ba9-4aef-bfc2-703b013cf28c", "name": "Retrieves a list of stages for a specific pipeline.", "request": { "name": "Retrieves a list of stages for a specific pipeline.", "description": { "content": "Retrieves a list of stages for a specific pipeline.", "type": "text/plain" }, "url": { "path": [ "v2", "pipelines", ":id", "stages" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "filter", "value": "string" }, { "disabled": false, "key": "page_size", "value": "100" }, { "disabled": false, "key": "page_token", "value": "string" }, { "disabled": false, "key": "order_by", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the pipeline identifier" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "545329e5-575f-4885-aad9-d5cbff07d184", "name": "the response containing the list of pipeline stages and the next page token", "originalRequest": { "url": { "path": [ "v2", "pipelines", ":id", "stages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_size", "value": "100" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the pipeline identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"next_page_token\": \"string\",\n \"stages\": [\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"pipeline_id\": \"string\"\n },\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"pipeline_id\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c39f84af-e8d0-4bdf-8131-3cf897f2e980", "name": "Retrieves the count of deals for a specific pipeline.", "request": { "name": "Retrieves the count of deals for a specific pipeline.", "description": { "content": "Retrieves the count of deals for a specific pipeline.", "type": "text/plain" }, "url": { "path": [ "v2", "pipelines", "{{id}}:dealsCount" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "filter", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "2c9e8145-bb11-4b17-86f8-69a41e988043", "name": "a Mono emitting the count of deals", "originalRequest": { "url": { "path": [ "v2", "pipelines", "{{id}}:dealsCount" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "7260", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "80d172ff-8214-416b-b7a8-306c5e5ebef1", "name": "Deals Stages", "description": { "content": "Deals Stages endpoints.", "type": "text/plain" }, "item": [ { "id": "a8063019-abde-4713-bc3e-2d38a2cc9cd0", "name": "List Stages", "request": { "name": "List Stages", "description": { "content": "Lists entities based on the provided ListCommand.", "type": "text/plain" }, "url": { "path": [ "v2", "stages" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "filter", "value": "string" }, { "disabled": false, "key": "page_token", "value": "string" }, { "disabled": false, "key": "order_by", "value": "string" }, { "disabled": false, "key": "page_size", "value": "100" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "6741557a-e90d-4717-b9d6-4ef10e8c8344", "name": "a response containing the list of entities", "originalRequest": { "url": { "path": [ "v2", "stages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "100" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"next_page_token\": \"string\",\n \"stages\": [\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"pipeline_id\": \"string\"\n },\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"pipeline_id\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0a13db51-45c5-434d-a32b-8e8967243fae", "name": "Create Stages", "request": { "name": "Create Stages", "description": { "content": "Creates a new entity.", "type": "text/plain" }, "url": { "path": [ "v2", "stages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"pipeline_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "248a6e5b-4d54-4f24-a45a-964f8025ff56", "name": "The created entity", "originalRequest": { "url": { "path": [ "v2", "stages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"pipeline_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"string\",\n \"pipeline_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0b98c636-7a71-4bb6-83a8-6e52880142e8", "name": "Get Stages", "request": { "name": "Get Stages", "description": { "content": "Retrieves an entity by its identifier.", "type": "text/plain" }, "url": { "path": [ "v2", "stages", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the entity identifier" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "c0e81b87-3112-4017-baa4-5814f3d38e1c", "name": "The retrieved entity", "originalRequest": { "url": { "path": [ "v2", "stages", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the entity identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"string\",\n \"pipeline_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e3021ddc-86b2-45af-9c2b-f4d6fb39069e", "name": "Deletes a stage by its identifier for a given tenant.", "request": { "name": "Deletes a stage by its identifier for a given tenant.", "description": { "content": "Deletes a stage by its identifier for a given tenant.", "type": "text/plain" }, "url": { "path": [ "v2", "stages", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "new_stage_id", "value": "string", "description": "the new stage identifier, can be null" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the stage identifier" } ] }, "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "8958e1a3-4f2f-4dec-91e4-00e18e7a0b27", "name": "A response indicating no content", "originalRequest": { "url": { "path": [ "v2", "stages", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "new_stage_id", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the stage identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9063f476-5478-4c58-801c-15c561aaf024", "name": "Update Stages", "request": { "name": "Update Stages", "description": { "content": "Updates an existing entity.", "type": "text/plain" }, "url": { "path": [ "v2", "stages", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "update_mask", "value": "string", "description": "(Required) the fields to update" }, { "disabled": false, "key": "update_mask", "value": "string", "description": "(Required) the fields to update" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the entity identifier" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"next_stage_id\": \"string\",\n \"pipeline_id\": \"string\",\n \"previous_stage_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "890a401f-9501-43f5-857a-8f50dc22eb15", "name": "The updated entity", "originalRequest": { "url": { "path": [ "v2", "stages", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "update_mask", "value": "string" }, { "key": "update_mask", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the entity identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"next_stage_id\": \"string\",\n \"pipeline_id\": \"string\",\n \"previous_stage_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"string\",\n \"pipeline_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "395843c7-539c-4486-ba85-eda04bb93b0a", "name": "Counts the number of deals in a specific stage.", "request": { "name": "Counts the number of deals in a specific stage.", "description": { "content": "Counts the number of deals in a specific stage.", "type": "text/plain" }, "url": { "path": [ "v2", "stages", ":id", "dealCount" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the stage identifier" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "6e2189df-e535-4256-be6c-cbb75c6007e8", "name": "the count of deals in the stage", "originalRequest": { "url": { "path": [ "v2", "stages", ":id", "dealCount" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the stage identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "7260", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e6a15bfe-f33f-42a0-b8b1-7b1e3bcab7a2", "name": "Retrieves a list of deals for a specific stage.", "request": { "name": "Retrieves a list of deals for a specific stage.", "description": { "content": "Retrieves a list of deals for a specific stage.", "type": "text/plain" }, "url": { "path": [ "v2", "stages", ":id", "deals" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "filter", "value": "string" }, { "disabled": false, "key": "page_size", "value": "100" }, { "disabled": false, "key": "page_token", "value": "string" }, { "disabled": false, "key": "order_by", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the stage identifier" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "c2a40ab1-b2f2-4c34-8c03-7a21e264541d", "name": "the response containing the list of deals and the next page token", "originalRequest": { "url": { "path": [ "v2", "stages", ":id", "deals" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_size", "value": "100" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the stage identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"next_page_token\": \"string\",\n \"deals\": [\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"value\": {\n \"amount\": 10.963942467117072,\n \"currency\": \"string\"\n },\n \"contact_ids\": [\n \"string\",\n \"string\"\n ],\n \"stage_id\": \"string\",\n \"stage_assignment_time\": \"1990-03-06T09:26:13.359Z\",\n \"owner_ids\": [\n \"string\",\n \"string\"\n ],\n \"task_ids\": [\n \"string\",\n \"string\"\n ],\n \"order_id\": \"string\",\n \"status\": \"string\",\n \"estimated_close_time\": \"1961-04-16T12:46:14.677Z\",\n \"closed_time\": \"1957-11-30T15:41:58.246Z\",\n \"custom_fields\": {\n \"key_0\": 964.3257342245182,\n \"key_1\": 2293.2741365918473\n }\n },\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"value\": {\n \"amount\": 283.3381106656252,\n \"currency\": \"string\"\n },\n \"contact_ids\": [\n \"string\",\n \"string\"\n ],\n \"stage_id\": \"string\",\n \"stage_assignment_time\": \"2015-12-13T22:38:37.765Z\",\n \"owner_ids\": [\n \"string\",\n \"string\"\n ],\n \"task_ids\": [\n \"string\",\n \"string\"\n ],\n \"order_id\": \"string\",\n \"status\": \"string\",\n \"estimated_close_time\": \"2008-11-10T02:41:16.339Z\",\n \"closed_time\": \"1986-04-18T23:32:59.027Z\",\n \"custom_fields\": {\n \"key_0\": 2814,\n \"key_1\": \"string\",\n \"key_2\": 8407.73109066036,\n \"key_3\": \"string\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] } ], "event": [], "variable": [ { "type": "string", "value": "https://api-intg.infusiontest.com/services", "key": "baseUrl" }, { "disabled": false, "description": { "content": "(Required) the pipeline identifier", "type": "text/plain" }, "type": "any", "value": "string", "key": "id" } ], "info": { "_postman_id": "2a793073-03b0-415a-a72e-75b64893d843", "name": "API Reference", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "Service Level Aggregation API (SLAAPI) to handle public API spec compliance\n\nContact Support:\n Name: Gryffindor\n Email: gryffindor@keap.com", "type": "text/plain" } } }