{ "item": [ { "id": "7fde3812-d48b-4f41-bc40-7bed08ee25bd", "name": "Deals", "description": { "content": "Deals endpoints.", "type": "text/plain" }, "item": [ { "id": "a9fb9628-0c4c-4a51-baac-f70326a9735b", "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": "c17a9353-88dc-4250-b021-56f22ad1b611", "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\": 9266.419999881584,\n \"currency\": \"string\"\n },\n \"contact_ids\": [\n \"string\",\n \"string\"\n ],\n \"stage_id\": \"string\",\n \"stage_assignment_time\": \"1973-04-01T23:25:41.678Z\",\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\": \"2006-11-01T07:48:54.158Z\",\n \"closed_time\": \"1958-02-02T16:52:03.780Z\",\n \"custom_fields\": {\n \"key_0\": \"string\",\n \"key_1\": 7779.343422591023\n }\n },\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"value\": {\n \"amount\": 2954.3938244112856,\n \"currency\": \"string\"\n },\n \"contact_ids\": [\n \"string\",\n \"string\"\n ],\n \"stage_id\": \"string\",\n \"stage_assignment_time\": \"2022-02-10T16:41:50.405Z\",\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\": \"1956-10-18T03:17:15.309Z\",\n \"closed_time\": \"1950-06-02T08:58:21.895Z\",\n \"custom_fields\": {\n \"key_0\": 8038,\n \"key_1\": \"string\",\n \"key_2\": 6266.336947778995,\n \"key_3\": 2303.6790099383666,\n \"key_4\": true\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "37b1c6d7-be91-4956-bd1d-a874931f19c4", "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\": false,\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\": 5730.768819599081,\n \"currency\": \"string\"\n },\n \"owner_id\": \"string\",\n \"estimated_close_time\": \"2023-03-08T09:33:41.315Z\",\n \"custom_fields\": {\n \"key_0\": false\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "90e45373-aed3-4c64-8c2b-48dc066ceb39", "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\": false,\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\": 2176.2184141762386,\n \"currency\": \"string\"\n },\n \"owner_id\": \"string\",\n \"estimated_close_time\": \"2000-11-21T20:30:43.791Z\",\n \"custom_fields\": {\n \"key_0\": \"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 \"value\": {\n \"amount\": 6892.521019503925,\n \"currency\": \"string\"\n },\n \"contact_ids\": [\n \"string\",\n \"string\"\n ],\n \"stage_id\": \"string\",\n \"stage_assignment_time\": \"2019-11-14T20:34:44.079Z\",\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\": \"2005-05-11T19:56:52.382Z\",\n \"closed_time\": \"1976-04-05T20:03:29.402Z\",\n \"custom_fields\": {\n \"key_0\": false,\n \"key_1\": 4443.446354944543\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "13f66fff-a088-4789-aed9-d746b5486327", "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": "5c62a196-c1c7-4adf-accf-5be124f57216", "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\": 5449.563164147666,\n \"currency\": \"string\"\n },\n \"contact_ids\": [\n \"string\",\n \"string\"\n ],\n \"stage_id\": \"string\",\n \"stage_assignment_time\": \"2001-11-13T17:31:47.314Z\",\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\": \"1999-03-22T05:09:30.054Z\",\n \"closed_time\": \"2002-08-07T14:59:26.262Z\",\n \"custom_fields\": {\n \"key_0\": true,\n \"key_1\": 7644.123442694113\n }\n },\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"value\": {\n \"amount\": 2045.13418933024,\n \"currency\": \"string\"\n },\n \"contact_ids\": [\n \"string\",\n \"string\"\n ],\n \"stage_id\": \"string\",\n \"stage_assignment_time\": \"2020-09-08T14:48:21.433Z\",\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\": \"1969-12-31T17:58:43.345Z\",\n \"closed_time\": \"1949-01-03T17:02:53.313Z\",\n \"custom_fields\": {\n \"key_0\": false,\n \"key_1\": 3772.0514192565856\n }\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b50357ca-0da1-42ee-8b2c-27df951919a1", "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": "dc3b5355-9e3e-4158-89ae-af6d6cf341ba", "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": "7446dd9d-a3cf-4b09-a9d4-2ccc4a0aa49b", "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": "331e4e92-a318-42f2-aa48-1f17a1843e37", "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\": 5919.373367627674,\n \"currency\": \"string\"\n },\n \"contact_ids\": [\n \"string\",\n \"string\"\n ],\n \"stage_id\": \"string\",\n \"stage_assignment_time\": \"1967-01-01T01:52:59.988Z\",\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\": \"1993-08-25T12:31:39.406Z\",\n \"closed_time\": \"2005-03-11T05:43:50.980Z\",\n \"custom_fields\": {\n \"key_0\": 8618,\n \"key_1\": 7870\n }\n },\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"value\": {\n \"amount\": 5069.1286740536625,\n \"currency\": \"string\"\n },\n \"contact_ids\": [\n \"string\",\n \"string\"\n ],\n \"stage_id\": \"string\",\n \"stage_assignment_time\": \"1997-07-13T15:31:42.783Z\",\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\": \"1995-12-28T03:23:26.623Z\",\n \"closed_time\": \"2024-08-02T18:49:38.179Z\",\n \"custom_fields\": {\n \"key_0\": 356.02390046240106,\n \"key_1\": \"string\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a02d0266-a9ab-41ae-8ecd-b732971f4094", "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": "8192ba13-0bd3-4f82-a3dd-865b9e7cf5ba", "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\": \"1974-01-28T08:14:25.316Z\",\n \"modified_time\": \"2003-01-13T20:50:57.677Z\",\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\": \"1957-10-10T16:02:12.135Z\",\n \"modified_time\": \"1984-02-19T22:35:01.440Z\",\n \"create_success\": false,\n \"error_message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1748e4e4-e125-4730-9a26-f2720a88db59", "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": "b8367ca4-37f7-4989-9dcb-e6c68324768a", "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\": \"2014-08-26T10:52:23.351Z\",\n \"modified_time\": \"1963-10-13T11:39:54.951Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0a9e29b8-61f7-4d9e-97ac-52f4256a4476", "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": "d5d60e9f-4192-462e-bf19-17f593865639", "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": "472a9c10-53b2-4f5e-95e6-3ef1e6f16c3e", "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": "2faa9f80-37bb-4c1f-bccc-b50148711b72", "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\": \"2014-08-26T10:52:23.351Z\",\n \"modified_time\": \"1963-10-13T11:39:54.951Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0d003906-218d-4004-9b34-258a0cfdf99c", "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\": true,\n \"id\": \"string\"\n },\n {\n \"primary_contact\": true,\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\": 3890.1040092255234,\n \"currency\": \"string\"\n },\n \"owner_id\": \"string\",\n \"estimated_close_time\": \"2023-01-25T17:21:07.524Z\",\n \"custom_fields\": {\n \"key_0\": 773\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\": 9459.315398963652,\n \"currency\": \"string\"\n },\n \"owner_id\": \"string\",\n \"estimated_close_time\": \"1977-08-08T16:56:22.353Z\",\n \"custom_fields\": {\n \"key_0\": 3265.181050301107,\n \"key_1\": false\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "c58b462e-1d26-47ef-ba8f-530abbb51c46", "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\": 162.1380170583664,\n \"currency\": \"string\"\n },\n \"owner_id\": \"string\",\n \"estimated_close_time\": \"1984-06-10T10:57:21.546Z\",\n \"custom_fields\": {\n \"key_0\": 3858.496172015087,\n \"key_1\": true,\n \"key_2\": 3473\n }\n },\n {\n \"contacts\": [\n {\n \"primary_contact\": true,\n \"id\": \"string\"\n },\n {\n \"primary_contact\": true,\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\": 1922.5026893528009,\n \"currency\": \"string\"\n },\n \"owner_id\": \"string\",\n \"estimated_close_time\": \"2012-03-20T01:36:06.136Z\",\n \"custom_fields\": {\n \"key_0\": \"string\"\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\": false,\n \"error_message\": \"string\"\n },\n \"key_1\": {\n \"deal_id\": \"string\",\n \"create_success\": false,\n \"error_message\": \"string\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "65e6352a-9c6f-4b47-8ff0-492fc60f7723", "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\": \"st\",\n \"to_stage\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "5948c0e3-194a-4150-a44c-0509d5bd4075", "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\": \"st\",\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": "8976b933-badb-4762-9b3a-2c400fe482d1", "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": "a6ed62c8-dd51-453c-827a-a70449cd55b4", "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\": 6892.521019503925,\n \"currency\": \"string\"\n },\n \"contact_ids\": [\n \"string\",\n \"string\"\n ],\n \"stage_id\": \"string\",\n \"stage_assignment_time\": \"2019-11-14T20:34:44.079Z\",\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\": \"2005-05-11T19:56:52.382Z\",\n \"closed_time\": \"1976-04-05T20:03:29.402Z\",\n \"custom_fields\": {\n \"key_0\": false,\n \"key_1\": 4443.446354944543\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3c27aea4-eeb6-45f0-a988-3b68b6e5309a", "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": "20f32540-f123-4428-8e9f-c9da455c2926", "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": "fac616ad-6fdd-4529-93d1-921dfd6515e8", "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\": 915.8973906750512,\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\": \"1973-05-30T23:46:45.967Z\",\n \"closed_date\": \"1995-04-12T09:31:02.339Z\",\n \"custom_fields\": {\n \"key_0\": 5684,\n \"key_1\": 5014.260366116059\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "dd27479c-8aa0-4568-a121-6944558261b2", "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\": 2820.2863420189715,\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\": \"1951-08-28T08:03:26.900Z\",\n \"closed_date\": \"1996-01-03T12:37:27.209Z\",\n \"custom_fields\": {\n \"key_0\": 8963,\n \"key_1\": 1453\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\": 6892.521019503925,\n \"currency\": \"string\"\n },\n \"contact_ids\": [\n \"string\",\n \"string\"\n ],\n \"stage_id\": \"string\",\n \"stage_assignment_time\": \"2019-11-14T20:34:44.079Z\",\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\": \"2005-05-11T19:56:52.382Z\",\n \"closed_time\": \"1976-04-05T20:03:29.402Z\",\n \"custom_fields\": {\n \"key_0\": false,\n \"key_1\": 4443.446354944543\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fb3fb427-f279-4a82-b42d-e8e63eb3b686", "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\": false,\n \"key_1\": false,\n \"key_2\": 8333.676273063675\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "f7cbe465-cff4-4701-9513-e209a812bd54", "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\": false,\n \"key_1\": false,\n \"key_2\": 8333.676273063675\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": "7a949f80-804b-4b65-aa72-c6a32fe3813e", "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": "6e9f41f6-a8f3-4c63-954c-1737a8d0e3d6", "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\": \"2013-06-26T10:20:10.113Z\",\n \"modified_time\": \"1980-05-22T13:19:51.163Z\"\n },\n {\n \"id\": \"string\",\n \"deal_id\": \"string\",\n \"body\": \"string\",\n \"created_by\": \"string\",\n \"created_time\": \"1990-07-22T18:46:35.496Z\",\n \"modified_time\": \"1990-09-13T13:09:09.444Z\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "58a4c889-a99d-4884-90a5-805d9bbd58d8", "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\": \"string\",\n \"created_by\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "2b9564dd-68d3-43b8-bc9b-675ff436c6b8", "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\": \"string\",\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\": \"2014-08-26T10:52:23.351Z\",\n \"modified_time\": \"1963-10-13T11:39:54.951Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bd6594ec-7b70-47ea-9e1f-affed97bec2e", "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": "eeb2f683-4b9c-4a4f-a21a-dff4d16341af", "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": "7308", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5434b5aa-89dc-410b-999f-e495f930edb5", "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": "9bad52b9-8117-4cd1-b29c-abc98322f1d9", "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": "d39f76fa-f2b8-4088-9913-7aeb2c86fbe1", "name": "Deals Custom Fields", "description": { "content": "Deals Custom Fields endpoints.", "type": "text/plain" }, "item": [ { "id": "d1ef727a-318b-4947-b81b-8e5f2bb7b11f", "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": "0d330963-7635-41ca-8784-d9f8a5e5d7e0", "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\": false,\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\": true,\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\": false,\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 \"next_page_token\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d5e9b8f7-65db-4bcf-822e-74158bf9c793", "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\": \"QO8LYAR8\",\n \"type\": {\n \"discriminator\": \"ARRAY\",\n \"primitive_type\": \"EMAIL\",\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\": \"BOOLEAN\",\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\": false,\n \"allow_future_dates\": false\n },\n \"boolean_display_options\": {\n \"display_type\": \"TOGGLE_BUTTON\"\n },\n \"duration\": {\n \"duration_units\": [\n \"HOURS\",\n \"DAYS\"\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\": 8967,\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\": 3988,\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\": 6297,\n \"size_type\": \"MAX\"\n }\n },\n {\n \"required\": true,\n \"size\": {\n \"size\": 762,\n \"size_type\": \"MAX\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "64ebd993-5135-4997-bc99-3c4e1204c538", "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\": \"J3RgPjtIN\",\n \"type\": {\n \"discriminator\": \"REF\",\n \"primitive_type\": \"BOOLEAN\",\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\": \"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\": false,\n \"allow_future_dates\": false\n },\n \"boolean_display_options\": {\n \"display_type\": \"CHECKBOX\"\n },\n \"duration\": {\n \"duration_units\": [\n \"MONTHS\",\n \"DAYS\"\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\": 8414,\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\": 734,\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\": 1033,\n \"size_type\": \"MIN\"\n }\n },\n {\n \"required\": false,\n \"size\": {\n \"size\": 8475,\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\": \"ARRAY\",\n \"primitive_type\": \"TEXT\",\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\": false,\n \"size\": {\n \"size\": 2261,\n \"size_type\": \"MAX\"\n }\n },\n {\n \"required\": false,\n \"size\": {\n \"size\": 3722,\n \"size_type\": \"MAX\"\n }\n }\n ],\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\": 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\": true\n },\n \"boolean_display_options\": {\n \"display_type\": \"RADIO\"\n },\n \"duration\": {\n \"duration_units\": [\n \"MONTHS\",\n \"DAYS\"\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\": 2555,\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\": 2901,\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": "c74c493b-5415-4a96-8552-80f13fdeb467", "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": "dd6c9f3d-5067-4c70-ae78-82f55790a46c", "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": "b8a7df24-8274-409e-a0a1-1a50942f72cb", "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\": \"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\": false,\n \"allow_future_dates\": true\n },\n \"boolean_display_options\": {\n \"display_type\": \"CHECKBOX\"\n },\n \"duration\": {\n \"duration_units\": [\n \"HOURS\",\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\": 4119,\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\": 6072,\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\": 7984,\n \"size_type\": \"MAX\"\n }\n },\n {\n \"required\": true,\n \"size\": {\n \"size\": 3088,\n \"size_type\": \"MAX\"\n }\n }\n ],\n \"deleted\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "98b35a56-ca11-4606-acff-3972b819eed9", "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\": false,\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\": 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\": true\n },\n \"boolean_display_options\": {\n \"display_type\": \"TOGGLE\"\n },\n \"duration\": {\n \"duration_units\": [\n \"HOURS\",\n \"MONTHS\"\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\": 6561,\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\": 9120,\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\": 8043,\n \"size_type\": \"MIN\"\n }\n },\n {\n \"required\": true,\n \"size\": {\n \"size\": 1590,\n \"size_type\": \"MIN\"\n }\n }\n ],\n \"deleted\": true\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\": \"ARRAY\",\n \"primitive_type\": \"TEXT\",\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\": false,\n \"size\": {\n \"size\": 2261,\n \"size_type\": \"MAX\"\n }\n },\n {\n \"required\": false,\n \"size\": {\n \"size\": 3722,\n \"size_type\": \"MAX\"\n }\n }\n ],\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\": 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\": true\n },\n \"boolean_display_options\": {\n \"display_type\": \"RADIO\"\n },\n \"duration\": {\n \"duration_units\": [\n \"MONTHS\",\n \"DAYS\"\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\": 2555,\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\": 2901,\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": "fefe3d4d-ac0d-434c-a018-2dc0d431cfdc", "name": "Deals Date Expression", "description": { "content": "Deals Date Expression endpoints.", "type": "text/plain" }, "item": [ { "id": "035462f7-42d1-4147-812c-7cd743c020aa", "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": "ec0b92a8-c607-446a-bf42-267763b0eed3", "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\": 9086,\n \"parse_start\": 7537,\n \"query\": \"string\",\n \"recurring\": false,\n \"recurse_until\": {\n \"dates\": [\n \"1952-09-12T12:23:37.416Z\",\n \"1967-06-09T14:11:57.678Z\"\n ],\n \"chain\": \"string\"\n },\n \"result\": {\n \"dates\": [\n \"2001-01-13T04:31:15.855Z\",\n \"1951-08-26T02:36:48.211Z\"\n ],\n \"chain\": \"string\"\n },\n \"time_inferred\": true,\n \"complete_match\": true\n },\n {\n \"date_inferred\": true,\n \"parse_end\": 8154,\n \"parse_start\": 2114,\n \"query\": \"string\",\n \"recurring\": true,\n \"recurse_until\": {\n \"dates\": [\n \"2023-09-25T02:22:29.096Z\",\n \"1968-05-02T19:18:41.261Z\"\n ],\n \"chain\": \"string\"\n },\n \"result\": {\n \"dates\": [\n \"2024-12-01T06:28:25.818Z\",\n \"1997-10-24T00:40:52.479Z\"\n ],\n \"chain\": \"string\"\n },\n \"time_inferred\": false,\n \"complete_match\": true\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "a64ea54c-0732-4093-b3e4-37b4f2438e8a", "name": "Deals Display Forms", "description": { "content": "Deals Display Forms endpoints.", "type": "text/plain" }, "item": [ { "id": "ae67f9bd-db1c-4fcd-8f7c-fcdbad84a1e2", "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": "02f4e9d1-1e4e-4385-8db2-b8421954dfb1", "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\": 8830,\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\": \"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\": 1067,\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": "684671f5-8e76-472c-a86c-0ba6c47fe18f", "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\": 1938,\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\": 673,\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\": 9242,\n \"description\": \"string\"\n },\n {\n \"properties\": [\n {\n \"source\": \"SYSTEM\",\n \"sort_order\": 9017,\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\": 3576,\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\": 7038,\n \"description\": \"string\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "4c0aa57e-7d39-42ed-8360-0f131b24eb6c", "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\": \"CUSTOM\",\n \"sort_order\": 8307,\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\": 7471,\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\": 6151,\n \"description\": \"string\"\n },\n {\n \"properties\": [\n {\n \"source\": \"SYSTEM\",\n \"sort_order\": 7678,\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\": 6027,\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\": 9655,\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\": 5452,\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\": \"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\": 9638,\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": "7fbb1a94-1842-4368-8c49-252fa68ac8bb", "name": "Deals Pipelines", "description": { "content": "Deals Pipelines endpoints.", "type": "text/plain" }, "item": [ { "id": "2114e1e9-e03b-4dd6-b937-193f3f4be586", "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": "5f51f1e7-e83d-4506-b056-415637888419", "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": "0f817462-2e2e-4c51-ac41-0664776c2470", "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": "6723e191-a572-4e7d-b30e-4995a49509e7", "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": "802c9f74-f6f1-4552-bdc4-1f4d8f320b00", "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": "403f13dc-07a7-4668-9ade-d982423b25db", "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\": \"39\",\n \"stat_total_deal_count\": 3190,\n \"stat_new_deal_count\": 8931\n },\n {\n \"pipeline_name\": \"string\",\n \"pipeline_id\": \"35\",\n \"stat_total_deal_count\": 9127,\n \"stat_new_deal_count\": 5530\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "87e26faa-688c-4fc1-82b3-eb13ec952530", "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": "bbec0374-c479-4466-aec7-a8cdd36c7361", "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": "63125748-7070-49ec-a44e-43095c51c6f2", "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": "b6f0bf89-16bd-4887-9e2b-ac97d03ca4df", "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": "false" } ], "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": "ba5cca4e-e8f9-4a54-adc7-8d4f9a2392bd", "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": "61efd6a4-b598-4a11-9d1f-ca4fd9a896c6", "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": "0ebdabe9-8950-4d64-a084-3d735646b243", "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\": true,\n \"filters\": [\n {\n \"key\": \"string\",\n \"operator\": \"GREATER_THAN_OR_EQUAL\",\n \"value\": \"string\"\n },\n {\n \"key\": \"string\",\n \"operator\": \"LESS_THAN\",\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": "f36bed52-ec30-4681-a7ed-d6a096933ce1", "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\": true,\n \"filters\": [\n {\n \"key\": \"string\",\n \"operator\": \"NOT_IN\",\n \"value\": \"string\"\n },\n {\n \"key\": \"string\",\n \"operator\": \"NOT_IN\",\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": "8192f0d5-4783-4c6e-a431-10f13830dc28", "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": "9b0ce614-02f0-47c4-992e-f6acc5d82657", "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\": 8537.145834336572,\n \"currency\": \"string\"\n },\n \"stage_id\": \"string\",\n \"stage_name\": \"string\",\n \"stage_assignment_time\": \"1988-01-01T10:35:47.548Z\",\n \"close_time\": \"1951-07-09T12:23:24.585Z\",\n \"estimated_close_time\": \"1955-03-11T03:47:56.027Z\",\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\": 8490.52170743805,\n \"currency\": \"string\"\n },\n \"stage_id\": \"string\",\n \"stage_name\": \"string\",\n \"stage_assignment_time\": \"1972-08-18T00:52:01.421Z\",\n \"close_time\": \"2012-02-26T08:18:33.219Z\",\n \"estimated_close_time\": \"2014-09-08T01:29:15.691Z\",\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}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6982b45d-a508-4edc-ba68-85d86b99f89f", "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": "535279f7-3d24-4fc6-97a3-281742f02814", "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": "69947733-58cb-4133-bb37-8d8170246c2b", "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\": \"ACTIVE\",\n \"label\": \"string\"\n },\n {\n \"value\": \"LOST\",\n \"label\": \"string\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "56a73f9e-1492-4db0-a026-b75f14e7cd2b", "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\": \"string\"\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\": \"ACTIVE\",\n \"label\": \"string\"\n },\n {\n \"value\": \"LOST\",\n \"label\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d590aac0-e1df-46f2-a426-04255efd8b38", "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": "26b1d2dd-0c9a-4f00-a5cf-bcbbd4ff51cc", "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": "c55be6b8-aaba-4500-97bd-6bc51473bff8", "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": "9ab82c30-a795-4d82-8217-e5957bee50ad", "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": "7308", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "bbb334e8-2daa-4968-b75c-f79f311a331d", "name": "Deals Stages", "description": { "content": "Deals Stages endpoints.", "type": "text/plain" }, "item": [ { "id": "24804cc5-3363-478d-99e6-b72bbc95c7fb", "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": "ea1ff27d-d20f-4241-9e80-1c61a4016fc2", "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": "db0837a6-d335-4c1d-961d-08fef3254ccd", "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\": \"str\",\n \"pipeline_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "6e6365a0-34b0-461c-ad15-239246239634", "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\": \"str\",\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": "1ece5d99-0836-4cff-97cd-181fe51e394b", "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": "05f7e9e1-6362-415c-8ac9-595047ba0292", "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": "0aa8baf6-8833-4c6d-a229-372269a44962", "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": "e0c00d1c-4ae0-4ee5-a5ff-850b8b9d8f06", "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": "526e77a1-b8fc-4336-afa4-dcb1f480f215", "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": "5ead8830-b00a-4ca6-aa2a-1ee0ae9e20ea", "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": "2f93edbd-e358-405b-8af3-8577362d0482", "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": "353bd264-dc62-49f5-8a68-580c462a8068", "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": "7308", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "46184f97-9330-49de-b271-1368395738a1", "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": "84fd7a5f-e397-492d-ba71-e045a3a48eec", "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\": 542.0541232853626,\n \"currency\": \"string\"\n },\n \"contact_ids\": [\n \"string\",\n \"string\"\n ],\n \"stage_id\": \"string\",\n \"stage_assignment_time\": \"1973-02-18T04:41:54.818Z\",\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\": \"1990-12-01T11:11:07.204Z\",\n \"closed_time\": \"2019-09-10T19:37:47.834Z\",\n \"custom_fields\": {\n \"key_0\": 4423.651936207349,\n \"key_1\": 704.4371619345413,\n \"key_2\": 9854.221200283559\n }\n },\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"value\": {\n \"amount\": 2278.136668584492,\n \"currency\": \"string\"\n },\n \"contact_ids\": [\n \"string\",\n \"string\"\n ],\n \"stage_id\": \"string\",\n \"stage_assignment_time\": \"1972-11-16T14:03:53.465Z\",\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\": \"1971-01-19T23:17:31.645Z\",\n \"closed_time\": \"1947-02-11T00:07:14.680Z\",\n \"custom_fields\": {\n \"key_0\": \"string\",\n \"key_1\": 4227\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] } ], "event": [], "variable": [ { "type": "string", "value": "https://api.infusionsoft.com/services", "key": "baseUrl" }, { "disabled": false, "description": { "content": "(Required) the pipeline identifier", "type": "text/plain" }, "type": "any", "value": "string", "key": "id" } ], "info": { "_postman_id": "f9af3307-0a19-484f-9c3f-6857d3c8cddd", "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" } } }