{ "item": [ { "id": "4ce3977a-6ef0-435f-a5c6-a9554147572b", "name": "Custom Fields", "description": { "content": "Custom Fields endpoints.", "type": "text/plain" }, "item": [ { "id": "5e1daf7c-ed2c-4e5f-aaf4-66a959c9e3f0", "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": "fdfe56b5-b1e9-4bbc-bfef-1653be553947", "name": "a list of PipelineCustomFields", "originalRequest": { "url": { "path": [ "v2", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "100" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"custom_fields\": [\n {\n \"default_value\": {},\n \"id\": \"string\",\n \"name\": \"string\",\n \"type\": {\n \"discriminator\": {\n \"description\": \"The discriminator for the model property type. This field is required.\",\n \"value\": \"\"\n },\n \"primitive_type\": {\n \"description\": \"The base primitive type of the custom field. This field is required.\",\n \"value\": \"\"\n },\n \"array\": {\n \"description\": \"The array property type of the custom field. This field is optional.\",\n \"nullable\": true,\n \"value\": \"\"\n },\n \"ref\": {\n \"description\": \"The reference property type of the custom field. This field is optional.\",\n \"nullable\": true,\n \"value\": \"\"\n }\n },\n \"label\": \"string\",\n \"description\": \"string\",\n \"helper_text\": \"string\",\n \"validators\": [\n {\n \"required\": true,\n \"size\": {\n \"description\": \"The size validator for the custom field. This field is required.\",\n \"value\": \"\"\n }\n },\n {\n \"required\": true,\n \"size\": {\n \"description\": \"The size validator for the custom field. This field is required.\",\n \"value\": \"\"\n }\n }\n ],\n \"display_options\": {\n \"hidden\": false,\n \"type\": {\n \"description\": \"The type of display options. This field is required.\",\n \"value\": \"\"\n },\n \"array_display_options\": {\n \"description\": \"The display options for array type custom fields. This field is optional.\",\n \"value\": \"\"\n },\n \"reference_type_display_options\": {\n \"description\": \"The display options for reference type custom fields. This field is optional.\",\n \"value\": \"\"\n },\n \"date_time_display_options\": {\n \"description\": \"The display options for date and time type custom fields. This field is optional.\",\n \"value\": \"\"\n },\n \"boolean_display_options\": {\n \"description\": \"The display options for boolean type custom fields. This field is optional.\",\n \"value\": \"\"\n },\n \"duration\": {\n \"description\": \"The display options for duration type custom fields. This field is optional.\",\n \"value\": \"\"\n }\n },\n \"options\": {\n \"display_type\": {\n \"description\": \"The display type of the custom field options. This field is required.\",\n \"value\": \"\"\n },\n \"groups\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"default_option_id\": \"string\",\n \"option_source\": {\n \"description\": \"The source of the custom field options. This field is optional.\",\n \"nullable\": true,\n \"value\": \"\"\n }\n }\n },\n {\n \"default_value\": {},\n \"id\": \"string\",\n \"name\": \"string\",\n \"type\": {\n \"discriminator\": {\n \"description\": \"The discriminator for the model property type. This field is required.\",\n \"value\": \"\"\n },\n \"primitive_type\": {\n \"description\": \"The base primitive type of the custom field. This field is required.\",\n \"value\": \"\"\n },\n \"array\": {\n \"description\": \"The array property type of the custom field. This field is optional.\",\n \"nullable\": true,\n \"value\": \"\"\n },\n \"ref\": {\n \"description\": \"The reference property type of the custom field. This field is optional.\",\n \"nullable\": true,\n \"value\": \"\"\n }\n },\n \"label\": \"string\",\n \"description\": \"string\",\n \"helper_text\": \"string\",\n \"validators\": [\n {\n \"required\": true,\n \"size\": {\n \"description\": \"The size validator for the custom field. This field is required.\",\n \"value\": \"\"\n }\n },\n {\n \"required\": false,\n \"size\": {\n \"description\": \"The size validator for the custom field. This field is required.\",\n \"value\": \"\"\n }\n }\n ],\n \"display_options\": {\n \"hidden\": false,\n \"type\": {\n \"description\": \"The type of display options. This field is required.\",\n \"value\": \"\"\n },\n \"array_display_options\": {\n \"description\": \"The display options for array type custom fields. This field is optional.\",\n \"value\": \"\"\n },\n \"reference_type_display_options\": {\n \"description\": \"The display options for reference type custom fields. This field is optional.\",\n \"value\": \"\"\n },\n \"date_time_display_options\": {\n \"description\": \"The display options for date and time type custom fields. This field is optional.\",\n \"value\": \"\"\n },\n \"boolean_display_options\": {\n \"description\": \"The display options for boolean type custom fields. This field is optional.\",\n \"value\": \"\"\n },\n \"duration\": {\n \"description\": \"The display options for duration type custom fields. This field is optional.\",\n \"value\": \"\"\n }\n },\n \"options\": {\n \"display_type\": {\n \"description\": \"The display type of the custom field options. This field is required.\",\n \"value\": \"\"\n },\n \"groups\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"default_option_id\": \"string\",\n \"option_source\": {\n \"description\": \"The source of the custom field options. This field is optional.\",\n \"nullable\": true,\n \"value\": \"\"\n }\n }\n }\n ],\n \"next_page_token\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9764c10b-b300-4a68-b335-448de1cbc72b", "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\": \"puo5F\",\n \"type\": {\n \"discriminator\": \"SIMPLE\",\n \"primitive_type\": \"DECIMAL\",\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\": \"DATE_TIME\",\n \"array_display_options\": {\n \"item_options\": {\n \"description\": \"Display options for the items in the array. This field is required.\",\n \"value\": \"\"\n },\n \"sortable\": true\n },\n \"reference_type_display_options\": {\n \"hidden\": true,\n \"card_options\": {\n \"card_properties\": {\n \"value\": \"\"\n }\n },\n \"title_property\": \"string\",\n \"description_property\": \"string\",\n \"reference_display_type\": \"DROPDOWN\",\n \"empty_state\": {\n \"description\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n },\n \"component_name\": \"string\"\n },\n \"date_time_display_options\": {\n \"allow_past_dates\": true,\n \"allow_future_dates\": true\n },\n \"boolean_display_options\": {\n \"display_type\": \"RADIO\"\n },\n \"duration\": {\n \"duration_units\": [\n \"HOURS\",\n \"MINUTES\"\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\": 8146,\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\": 1982,\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\": 8147,\n \"size_type\": \"MIN\"\n }\n },\n {\n \"required\": false,\n \"size\": {\n \"size\": 3859,\n \"size_type\": \"MIN\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "f85d1191-828f-43b8-98af-19a0ae9ee218", "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\": \"yjTaoNNr\",\n \"type\": {\n \"discriminator\": \"REF\",\n \"primitive_type\": \"ARRAY\",\n \"array\": {\n \"list_type\": {\n \"description\": \"The type of the list contained in the array property. This field is required.\",\n \"value\": \"\"\n }\n },\n \"ref\": {\n \"reference_type\": {\n \"category\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n \"fields\": [\n \"string\",\n \"string\"\n ]\n }\n },\n \"label\": \"string\",\n \"description\": \"string\",\n \"example_value\": {},\n \"helper_text\": \"string\",\n \"default_value\": {},\n \"display_options\": {\n \"hidden\": true,\n \"type\": \"ARRAY\",\n \"array_display_options\": {\n \"item_options\": {\n \"description\": \"Display options for the items in the array. This field is required.\",\n \"value\": \"\"\n },\n \"sortable\": 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\": \"RADIO\"\n },\n \"duration\": {\n \"duration_units\": [\n \"MONTHS\",\n \"YEARS\"\n ]\n }\n },\n \"options\": {\n \"display_type\": \"DROPDOWN\",\n \"groups\": [\n {\n \"options\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"sort_order\": {\n \"value\": \"\"\n },\n \"subtitle\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"sort_order\": {\n \"value\": \"\"\n },\n \"subtitle\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n }\n ],\n \"sort_order\": 342,\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\": 2405,\n \"header\": \"string\"\n }\n ],\n \"default_option_id\": \"string\",\n \"option_source\": {\n \"category\": \"string\",\n \"name\": \"string\"\n }\n },\n \"validators\": [\n {\n \"required\": false,\n \"size\": {\n \"size\": 8757,\n \"size_type\": \"MAX\"\n }\n },\n {\n \"required\": false,\n \"size\": {\n \"size\": 477,\n \"size_type\": \"MAX\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"default_value\": {},\n \"id\": \"string\",\n \"name\": \"string\",\n \"type\": {\n \"discriminator\": \"REF\",\n \"primitive_type\": \"PHONE\",\n \"array\": {\n \"list_type\": {\n \"description\": \"The type of the list contained in the array property. This field is required.\",\n \"value\": \"\"\n }\n },\n \"ref\": {\n \"reference_type\": {\n \"category\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n \"fields\": [\n \"string\",\n \"string\"\n ]\n }\n },\n \"label\": \"string\",\n \"description\": \"string\",\n \"helper_text\": \"string\",\n \"validators\": [\n {\n \"required\": true,\n \"size\": {\n \"size\": 1827,\n \"size_type\": \"MAX\"\n }\n },\n {\n \"required\": true,\n \"size\": {\n \"size\": 3783,\n \"size_type\": \"MAX\"\n }\n }\n ],\n \"display_options\": {\n \"hidden\": true,\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\": \"RADIO\"\n },\n \"duration\": {\n \"duration_units\": [\n \"DAYS\",\n \"MONTHS\"\n ]\n }\n },\n \"options\": {\n \"display_type\": \"CHECKBOX\",\n \"groups\": [\n {\n \"options\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"sort_order\": {\n \"value\": \"\"\n },\n \"subtitle\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"sort_order\": {\n \"value\": \"\"\n },\n \"subtitle\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n }\n ],\n \"sort_order\": 2114,\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\": 2684,\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": "c0283400-7716-4bd4-8108-b6498bdd8a6b", "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": "b0e1b408-b761-494d-92c1-803cc7a10191", "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": "91b42e3a-084e-44c6-b020-81348fc19448", "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\": 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\": false\n },\n \"reference_type_display_options\": {\n \"hidden\": false,\n \"card_options\": {\n \"card_properties\": {\n \"value\": \"\"\n }\n },\n \"title_property\": \"string\",\n \"description_property\": \"string\",\n \"reference_display_type\": \"CARD\",\n \"empty_state\": {\n \"description\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n },\n \"component_name\": \"string\"\n },\n \"date_time_display_options\": {\n \"allow_past_dates\": true,\n \"allow_future_dates\": false\n },\n \"boolean_display_options\": {\n \"display_type\": \"TOGGLE\"\n },\n \"duration\": {\n \"duration_units\": [\n \"MINUTES\",\n \"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\": 7634,\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\": 6673,\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\": 8942,\n \"size_type\": \"MAX\"\n }\n },\n {\n \"required\": false,\n \"size\": {\n \"size\": 3916,\n \"size_type\": \"MAX\"\n }\n }\n ],\n \"deleted\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "3880cd30-f85b-468f-bc68-c2bfa408573f", "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\": \"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\": \"DROPDOWN\",\n \"empty_state\": {\n \"description\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n },\n \"component_name\": \"string\"\n },\n \"date_time_display_options\": {\n \"allow_past_dates\": true,\n \"allow_future_dates\": false\n },\n \"boolean_display_options\": {\n \"display_type\": \"RADIO\"\n },\n \"duration\": {\n \"duration_units\": [\n \"MONTHS\",\n \"HOURS\"\n ]\n }\n },\n \"options\": {\n \"display_type\": \"DROPDOWN\",\n \"groups\": [\n {\n \"options\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"sort_order\": {\n \"value\": \"\"\n },\n \"subtitle\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"sort_order\": {\n \"value\": \"\"\n },\n \"subtitle\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n }\n ],\n \"sort_order\": 9293,\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\": 8704,\n \"header\": \"string\"\n }\n ],\n \"default_option_id\": \"string\",\n \"option_source\": {\n \"category\": \"string\",\n \"name\": \"string\"\n }\n },\n \"validators\": [\n {\n \"required\": false,\n \"size\": {\n \"size\": 5233,\n \"size_type\": \"MIN\"\n }\n },\n {\n \"required\": false,\n \"size\": {\n \"size\": 4791,\n \"size_type\": \"MIN\"\n }\n }\n ],\n \"deleted\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"default_value\": {},\n \"id\": \"string\",\n \"name\": \"string\",\n \"type\": {\n \"discriminator\": \"REF\",\n \"primitive_type\": \"PHONE\",\n \"array\": {\n \"list_type\": {\n \"description\": \"The type of the list contained in the array property. This field is required.\",\n \"value\": \"\"\n }\n },\n \"ref\": {\n \"reference_type\": {\n \"category\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n },\n \"fields\": [\n \"string\",\n \"string\"\n ]\n }\n },\n \"label\": \"string\",\n \"description\": \"string\",\n \"helper_text\": \"string\",\n \"validators\": [\n {\n \"required\": true,\n \"size\": {\n \"size\": 1827,\n \"size_type\": \"MAX\"\n }\n },\n {\n \"required\": true,\n \"size\": {\n \"size\": 3783,\n \"size_type\": \"MAX\"\n }\n }\n ],\n \"display_options\": {\n \"hidden\": true,\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\": \"RADIO\"\n },\n \"duration\": {\n \"duration_units\": [\n \"DAYS\",\n \"MONTHS\"\n ]\n }\n },\n \"options\": {\n \"display_type\": \"CHECKBOX\",\n \"groups\": [\n {\n \"options\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"sort_order\": {\n \"value\": \"\"\n },\n \"subtitle\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"sort_order\": {\n \"value\": \"\"\n },\n \"subtitle\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n }\n ],\n \"sort_order\": 2114,\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\": 2684,\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": "c58fd6a5-8007-4f3b-9548-76024acd26dd", "name": "DateExpression", "description": { "content": "DateExpression endpoints.", "type": "text/plain" }, "item": [ { "id": "2a4c0328-5bc7-4a90-b603-bb3b063e4d6c", "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": "4272f10f-6d22-419e-8b9d-26265466634d", "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\": false,\n \"parse_end\": 3869,\n \"parse_start\": 7109,\n \"query\": \"string\",\n \"recurring\": false,\n \"recurse_until\": {\n \"dates\": [\n \"1952-04-21T02:01:52.045Z\",\n \"2005-07-10T20:07:34.859Z\"\n ],\n \"chain\": \"string\"\n },\n \"result\": {\n \"dates\": [\n \"1980-09-03T16:02:23.380Z\",\n \"1975-08-26T07:51:54.119Z\"\n ],\n \"chain\": \"string\"\n },\n \"time_inferred\": false,\n \"complete_match\": false\n },\n {\n \"date_inferred\": true,\n \"parse_end\": 1102,\n \"parse_start\": 6227,\n \"query\": \"string\",\n \"recurring\": true,\n \"recurse_until\": {\n \"dates\": [\n \"1975-12-15T13:16:05.905Z\",\n \"1997-07-01T02:16:28.660Z\"\n ],\n \"chain\": \"string\"\n },\n \"result\": {\n \"dates\": [\n \"1978-07-31T14:48:58.340Z\",\n \"1957-06-21T05:48:49.219Z\"\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": "ef51895a-ec89-4eb3-a9c0-2fcdfac80484", "name": "Deals", "description": { "content": "Deals endpoints.", "type": "text/plain" }, "item": [ { "id": "c317a782-4cd6-4313-bf4e-c928143769f1", "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": "3692a80f-5cc0-4279-b681-f0f3c53ccc2f", "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\": 2255.4018835818647,\n \"currency\": \"string\"\n },\n \"contact_ids\": [\n \"string\",\n \"string\"\n ],\n \"stage_id\": \"string\",\n \"stage_assignment_time\": \"2001-04-21T07:52:11.836Z\",\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\": \"1986-07-28T22:41:10.229Z\",\n \"closed_time\": \"2024-09-16T01:12:17.129Z\",\n \"custom_fields\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": false\n }\n },\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"value\": {\n \"amount\": 4096.173338970714,\n \"currency\": \"string\"\n },\n \"contact_ids\": [\n \"string\",\n \"string\"\n ],\n \"stage_id\": \"string\",\n \"stage_assignment_time\": \"1960-10-25T07:52:44.289Z\",\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-12-04T13:09:32.092Z\",\n \"closed_time\": \"2012-06-29T13:08:13.037Z\",\n \"custom_fields\": {\n \"key_0\": \"string\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9f4088bb-5a80-4422-bc1b-9196f02365ed", "name": "Create Deal", "request": { "name": "Create Deal", "description": { "content": "Creates a new entity.", "type": "text/plain" }, "url": { "path": [ "v2", "deals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"contacts\": [\n {\n \"primary_contact\": true,\n \"id\": \"string\"\n },\n {\n \"primary_contact\": true,\n \"id\": \"string\"\n }\n ],\n \"name\": \"string\",\n \"owners\": [\n {\n \"id\": \"string\"\n },\n {\n \"id\": \"string\"\n }\n ],\n \"stage_id\": \"string\",\n \"status\": \"string\",\n \"task_ids\": [\n \"string\",\n \"string\"\n ],\n \"value\": {\n \"amount\": 8350.109356426732,\n \"currency\": \"string\"\n },\n \"owner_id\": \"string\",\n \"estimated_close_time\": \"1973-08-12T22:53:30.959Z\",\n \"custom_fields\": {\n \"key_0\": \"string\",\n \"key_1\": 9074.574322503728\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "cb3e8022-37ee-4e32-8ff3-c5a22be1c105", "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\": 8804.69997043555,\n \"currency\": \"string\"\n },\n \"owner_id\": \"string\",\n \"estimated_close_time\": \"2023-06-03T23:37:20.392Z\",\n \"custom_fields\": {\n \"key_0\": \"string\",\n \"key_1\": true\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\": 9344.059177035875,\n \"currency\": \"string\"\n },\n \"contact_ids\": [\n \"string\",\n \"string\"\n ],\n \"stage_id\": \"string\",\n \"stage_assignment_time\": \"2024-05-25T23:28:10.214Z\",\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\": \"1948-06-15T03:21:19.054Z\",\n \"closed_time\": \"1979-12-23T21:19:38.538Z\",\n \"custom_fields\": {\n \"key_0\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f28a54b5-07ff-41ae-b422-3426f4d1de58", "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": "9c5f664b-45b3-4e3e-8625-6721c07143c2", "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\": 9938.736325853975,\n \"currency\": \"string\"\n },\n \"contact_ids\": [\n \"string\",\n \"string\"\n ],\n \"stage_id\": \"string\",\n \"stage_assignment_time\": \"1972-08-04T02:20:58.862Z\",\n \"owner_ids\": [\n \"string\",\n \"string\"\n ],\n \"task_ids\": [\n \"string\",\n \"string\"\n ],\n \"order_id\": \"string\",\n \"status\": \"string\",\n \"estimated_close_time\": \"1988-09-22T11:17:20.198Z\",\n \"closed_time\": \"1998-07-15T13:39:05.166Z\",\n \"custom_fields\": {\n \"key_0\": 7580\n }\n },\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"value\": {\n \"amount\": 6596.458151535358,\n \"currency\": \"string\"\n },\n \"contact_ids\": [\n \"string\",\n \"string\"\n ],\n \"stage_id\": \"string\",\n \"stage_assignment_time\": \"1993-08-15T11:40:35.696Z\",\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\": \"2025-01-11T16:44:02.075Z\",\n \"closed_time\": \"1990-10-18T06:39:46.228Z\",\n \"custom_fields\": {\n \"key_0\": 6640,\n \"key_1\": \"string\"\n }\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ec851e86-94b5-477c-aab8-72400cb52505", "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": "2f28734d-8c7c-4607-9c09-3868590410d7", "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": "f131d201-385b-4a6e-8ad2-5bba9ebb170f", "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": "7ba643ac-5b21-4abd-9244-44e7f483e820", "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\": 5723.606499934282,\n \"currency\": \"string\"\n },\n \"contact_ids\": [\n \"string\",\n \"string\"\n ],\n \"stage_id\": \"string\",\n \"stage_assignment_time\": \"2002-05-22T07:01:20.031Z\",\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\": \"1954-05-17T17:40:18.669Z\",\n \"closed_time\": \"1947-04-11T02:10:39.305Z\",\n \"custom_fields\": {\n \"key_0\": 7175.943733964998,\n \"key_1\": 8472.588171074\n }\n },\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"value\": {\n \"amount\": 4101.445885355981,\n \"currency\": \"string\"\n },\n \"contact_ids\": [\n \"string\",\n \"string\"\n ],\n \"stage_id\": \"string\",\n \"stage_assignment_time\": \"2009-03-26T18:11:33.687Z\",\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-03-30T21:23:21.730Z\",\n \"closed_time\": \"2002-04-30T08:43:13.510Z\",\n \"custom_fields\": {\n \"key_0\": 7255\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1a29d8a0-c142-426b-ad43-61ee6185e9b9", "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": "6230a6da-3c0e-4d66-a03f-abced5177df3", "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\": \"1980-01-25T21:52:18.468Z\",\n \"modified_time\": \"1957-08-07T12:34:04.615Z\",\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\": \"1988-04-20T15:26:39.475Z\",\n \"modified_time\": \"1949-11-30T15:24:07.599Z\",\n \"create_success\": true,\n \"error_message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8e8fcf36-e409-4b1e-ae4a-4da801c79d54", "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": "3a637722-aaf1-4a96-b45c-390332c79c1a", "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\": \"2024-03-08T09:20:37.643Z\",\n \"modified_time\": \"1987-05-10T07:44:11.313Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a9926df7-ec98-4ee5-8496-b7a076643273", "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": "aa0a601a-c04e-4bc2-a600-6cc56d6f9789", "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": "1998c6f2-906a-4e73-867a-a52f4594cd25", "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": "c8632e30-077d-4065-acd7-efbb204ed740", "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\": \"2024-03-08T09:20:37.643Z\",\n \"modified_time\": \"1987-05-10T07:44:11.313Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5231f4af-4d02-40f4-ad32-df5a6783dad1", "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\": 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\": 7413.383365963522,\n \"currency\": \"string\"\n },\n \"owner_id\": \"string\",\n \"estimated_close_time\": \"1969-09-27T17:52:35.576Z\",\n \"custom_fields\": {\n \"key_0\": true,\n \"key_1\": 6726.489683077579\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\": 2437.0746923625043,\n \"currency\": \"string\"\n },\n \"owner_id\": \"string\",\n \"estimated_close_time\": \"1996-07-07T13:28:41.509Z\",\n \"custom_fields\": {\n \"key_0\": \"string\",\n \"key_1\": 1103.052852655355,\n \"key_2\": 3980.2693275315114\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "75efe668-9293-4c81-b14d-aaa535f142e0", "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\": false,\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\": 9810.09913835522,\n \"currency\": \"string\"\n },\n \"owner_id\": \"string\",\n \"estimated_close_time\": \"1957-06-19T10:55:00.658Z\",\n \"custom_fields\": {\n \"key_0\": 8803.091354238215,\n \"key_1\": false\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\": 4254.244046046123,\n \"currency\": \"string\"\n },\n \"owner_id\": \"string\",\n \"estimated_close_time\": \"1961-10-01T11:36:09.267Z\",\n \"custom_fields\": {\n \"key_0\": 2343\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\": true,\n \"error_message\": \"string\"\n },\n \"key_2\": {\n \"deal_id\": \"string\",\n \"create_success\": true,\n \"error_message\": \"string\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c79362f9-ce9a-4bf5-ab51-b6d660644652", "name": "Moves the active deals of specified contacts from one stage to another, in bulk.", "request": { "name": "Moves the active deals of specified contacts from one stage to another, in bulk.", "description": { "content": "Moves the active deals of specified contacts from one stage to another, in bulk.", "type": "text/plain" }, "url": { "path": [ "v2", "deals", "moveByContactIds" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"contact_ids\": [\n \"string\"\n ],\n \"from_stage\": \"string\",\n \"to_stage\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "6ff2df9f-b3e6-4e7c-a298-f7c1abb50a70", "name": "the IDs of the Deals moved", "originalRequest": { "url": { "path": [ "v2", "deals", "moveByContactIds" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contact_ids\": [\n \"string\"\n ],\n \"from_stage\": \"string\",\n \"to_stage\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"moved_deal_ids\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d98b872c-c2f7-4092-b4b8-e0c4c3b2de5b", "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": "66ef8983-a17d-4dc2-a2c4-676f0db5b584", "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\": 9344.059177035875,\n \"currency\": \"string\"\n },\n \"contact_ids\": [\n \"string\",\n \"string\"\n ],\n \"stage_id\": \"string\",\n \"stage_assignment_time\": \"2024-05-25T23:28:10.214Z\",\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\": \"1948-06-15T03:21:19.054Z\",\n \"closed_time\": \"1979-12-23T21:19:38.538Z\",\n \"custom_fields\": {\n \"key_0\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "90240ffd-8600-4645-90dc-72689969fb8d", "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": "a8f04c70-a4d8-4861-9e45-cdde2ff505e8", "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": "760348d5-132a-436c-9686-fcedd68763ae", "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\": 3517.418351828403,\n \"currency_code\": \"string\",\n \"contacts\": [\n {\n \"primary_contact\": true,\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\": \"strin\",\n \"estimated_close_date\": \"1950-03-04T11:51:21.207Z\",\n \"closed_date\": \"2011-03-09T20:18:19.564Z\",\n \"custom_fields\": {\n \"key_0\": 6346,\n \"key_1\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "6b986ec4-a033-4f32-9707-1c8ab568e6c7", "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\": 7839.639536135461,\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\": \"2012-12-24T10:15:25.170Z\",\n \"closed_date\": \"2024-12-12T08:29:24.409Z\",\n \"custom_fields\": {\n \"key_0\": \"string\"\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\": 9344.059177035875,\n \"currency\": \"string\"\n },\n \"contact_ids\": [\n \"string\",\n \"string\"\n ],\n \"stage_id\": \"string\",\n \"stage_assignment_time\": \"2024-05-25T23:28:10.214Z\",\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\": \"1948-06-15T03:21:19.054Z\",\n \"closed_time\": \"1979-12-23T21:19:38.538Z\",\n \"custom_fields\": {\n \"key_0\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "732bebae-2f33-47b3-8fc7-52a4b454e452", "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\": 5658.7540603593125,\n \"key_1\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "3aa02c39-b8f2-4909-9b49-44b0154c7032", "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\": 5658.7540603593125,\n \"key_1\": \"string\"\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": "b8af585e-54a6-4c02-891e-aa424a1b080a", "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": "0c4535ea-94e5-458b-b935-7ba9536a44f7", "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\": \"1994-11-12T07:52:59.827Z\",\n \"modified_time\": \"1992-10-07T15:34:49.545Z\"\n },\n {\n \"id\": \"string\",\n \"deal_id\": \"string\",\n \"body\": \"string\",\n \"created_by\": \"string\",\n \"created_time\": \"2004-02-05T21:22:51.267Z\",\n \"modified_time\": \"1978-04-04T16:11:28.444Z\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9450e7b7-c26b-4fa6-85dc-9e9a1c59faba", "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": "88ca6b52-a68f-4842-bec5-ddb39d0385c7", "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\": \"2024-03-08T09:20:37.643Z\",\n \"modified_time\": \"1987-05-10T07:44:11.313Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a1859a22-939c-4f39-bb8e-dc39046115b0", "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": "c03d0415-7461-41c0-bb9b-dee1cf6b4de0", "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": "7717", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3f9ba771-7551-40e3-8a4e-6a31d29a999a", "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": "7fe97c15-1c61-4fc4-bee6-435b3e39fae2", "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": "e3cf4e06-506f-48e5-bbb3-6d1461c4ead6", "name": "Display Forms", "description": { "content": "Display Forms endpoints.", "type": "text/plain" }, "item": [ { "id": "9f6db8d6-bf59-49cc-a198-497d221a105c", "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": "003b0ee9-b2c2-4e0d-898a-20f5008121dc", "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\": 293,\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\": 7363,\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": "574ff74c-80c3-4b3b-87b5-56b6c32615be", "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\": 5428,\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\": 2135,\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\": 5161,\n \"description\": \"string\"\n },\n {\n \"properties\": [\n {\n \"source\": \"CUSTOM\",\n \"sort_order\": 2154,\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\": 1289,\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\": 9086,\n \"description\": \"string\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "98362786-7749-4fbb-87b4-098ca0a2b31d", "name": "the updated DisplayForm", "originalRequest": { "url": { "path": [ "v2", "pipelines", ":id", "form" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the ID of the pipeline containing the form" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"groups\": [\n {\n \"properties\": [\n {\n \"source\": \"SYSTEM\",\n \"sort_order\": 7874,\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\": 326,\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\": 34,\n \"description\": \"string\"\n },\n {\n \"properties\": [\n {\n \"source\": \"CUSTOM\",\n \"sort_order\": 1968,\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\": 6075,\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\": 7404,\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\": 6184,\n \"title\": \"string\",\n \"description\": \"string\",\n \"properties\": [\n {\n \"id\": \"string\",\n \"property\": {\n \"default_value\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"label\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"helper_text\": {\n \"value\": \"\"\n },\n \"validators\": {\n \"value\": \"\"\n },\n \"display_options\": {\n \"value\": \"\"\n },\n \"options\": {\n \"value\": \"\"\n }\n },\n \"source\": \"SYSTEM\",\n \"system_field_record\": \"string\",\n \"system_field_id\": \"string\",\n \"label\": \"string\",\n \"description\": \"string\",\n \"helper_text\": \"string\",\n \"default_value\": {},\n \"display_options\": {\n \"hidden\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"array_display_options\": {\n \"value\": \"\"\n },\n \"reference_type_display_options\": {\n \"value\": \"\"\n },\n \"date_time_display_options\": {\n \"value\": \"\"\n },\n \"boolean_display_options\": {\n \"value\": \"\"\n },\n \"duration\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"id\": \"string\",\n \"property\": {\n \"default_value\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"label\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"helper_text\": {\n \"value\": \"\"\n },\n \"validators\": {\n \"value\": \"\"\n },\n \"display_options\": {\n \"value\": \"\"\n },\n \"options\": {\n \"value\": \"\"\n }\n },\n \"source\": \"SYSTEM\",\n \"system_field_record\": \"string\",\n \"system_field_id\": \"string\",\n \"label\": \"string\",\n \"description\": \"string\",\n \"helper_text\": \"string\",\n \"default_value\": {},\n \"display_options\": {\n \"hidden\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"array_display_options\": {\n \"value\": \"\"\n },\n \"reference_type_display_options\": {\n \"value\": \"\"\n },\n \"date_time_display_options\": {\n \"value\": \"\"\n },\n \"boolean_display_options\": {\n \"value\": \"\"\n },\n \"duration\": {\n \"value\": \"\"\n }\n }\n }\n ]\n },\n {\n \"id\": \"string\",\n \"sort_order\": 6915,\n \"title\": \"string\",\n \"description\": \"string\",\n \"properties\": [\n {\n \"id\": \"string\",\n \"property\": {\n \"default_value\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"label\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"helper_text\": {\n \"value\": \"\"\n },\n \"validators\": {\n \"value\": \"\"\n },\n \"display_options\": {\n \"value\": \"\"\n },\n \"options\": {\n \"value\": \"\"\n }\n },\n \"source\": \"SYSTEM\",\n \"system_field_record\": \"string\",\n \"system_field_id\": \"string\",\n \"label\": \"string\",\n \"description\": \"string\",\n \"helper_text\": \"string\",\n \"default_value\": {},\n \"display_options\": {\n \"hidden\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"array_display_options\": {\n \"value\": \"\"\n },\n \"reference_type_display_options\": {\n \"value\": \"\"\n },\n \"date_time_display_options\": {\n \"value\": \"\"\n },\n \"boolean_display_options\": {\n \"value\": \"\"\n },\n \"duration\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"id\": \"string\",\n \"property\": {\n \"default_value\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"label\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"helper_text\": {\n \"value\": \"\"\n },\n \"validators\": {\n \"value\": \"\"\n },\n \"display_options\": {\n \"value\": \"\"\n },\n \"options\": {\n \"value\": \"\"\n }\n },\n \"source\": \"SYSTEM\",\n \"system_field_record\": \"string\",\n \"system_field_id\": \"string\",\n \"label\": \"string\",\n \"description\": \"string\",\n \"helper_text\": \"string\",\n \"default_value\": {},\n \"display_options\": {\n \"hidden\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"array_display_options\": {\n \"value\": \"\"\n },\n \"reference_type_display_options\": {\n \"value\": \"\"\n },\n \"date_time_display_options\": {\n \"value\": \"\"\n },\n \"boolean_display_options\": {\n \"value\": \"\"\n },\n \"duration\": {\n \"value\": \"\"\n }\n }\n }\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "1664d88a-7f2c-4376-9168-5a3a463f9a7e", "name": "Pipelines", "description": { "content": "Pipelines endpoints.", "type": "text/plain" }, "item": [ { "id": "fd79f3c9-a86b-499b-98b4-1eca6aed6601", "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": "29f3f911-04a8-45bf-b43b-fc691980f9e6", "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": "7a882899-0707-4ef8-a67a-b65283b85ec4", "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": "e847f796-070e-4fc0-af37-5c800bc6a059", "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": "542da140-379a-45ee-abf4-05f30950c365", "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": "57d45c4b-4457-419a-b3ef-7e86e7ba6e50", "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\": \"8680944229\",\n \"stat_total_deal_count\": 3613,\n \"stat_new_deal_count\": 4682\n },\n {\n \"pipeline_name\": \"string\",\n \"pipeline_id\": \"854490\",\n \"stat_total_deal_count\": 392,\n \"stat_new_deal_count\": 4738\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3aedb387-f282-4094-80a2-394c3b6d6d4f", "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": "a00f50bb-80b0-4da2-b618-07c46c88fb5b", "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": "dbeca0b0-2ed5-4c24-8557-8f325effc843", "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": "true", "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": "eb50f3af-2485-46a9-b11c-c76696e92d30", "name": "A response indicating no content", "originalRequest": { "url": { "path": [ "v2", "pipelines", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "new_stage_id", "value": "string" }, { "key": "allow_cleanup", "value": "true" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the pipeline identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "44eca38d-f398-4d22-92f1-fd889f6406f1", "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": "96571cd4-4b40-4e8e-a601-13dd6b5bf2ae", "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": "b0301467-860e-46d5-b028-5c269c1703b6", "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\": \"BETWEEN\",\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" } } } }, "response": [ { "id": "1ce1f45b-3804-4b6b-8bbf-f120ee8fb3c5", "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_EQUALS\",\n \"value\": \"string\"\n },\n {\n \"key\": \"string\",\n \"operator\": \"INCLUDES_ANY\",\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\": false,\n \"error_message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "02cd3d03-271b-467d-aab9-28673a86cc7a", "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": "38763861-ca23-4114-a04d-50e38f422dc1", "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\": \"str\",\n \"id\": \"string\",\n \"value\": {\n \"amount\": 8833.820118519709,\n \"currency\": \"string\"\n },\n \"stage_id\": \"string\",\n \"stage_name\": \"string\",\n \"stage_assignment_time\": \"2025-09-15T01:27:29.287Z\",\n \"close_time\": \"1950-09-11T22:54:36.687Z\",\n \"estimated_close_time\": \"2002-07-09T23:42:43.550Z\",\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\": 745.8055911869433,\n \"currency\": \"string\"\n },\n \"stage_id\": \"string\",\n \"stage_name\": \"string\",\n \"stage_assignment_time\": \"2013-12-23T03:17:57.553Z\",\n \"close_time\": \"1994-04-27T05:25:10.301Z\",\n \"estimated_close_time\": \"2016-08-01T22:22:34.628Z\",\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\": \"WON\",\n \"order\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4db8da56-c94d-4768-b68e-d9780ed5370d", "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": "d03ea130-5ea7-4dbf-b127-eee44e3c630e", "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\": \"LOST\",\n \"label\": \"string\"\n },\n {\n \"value\": \"WON\",\n \"label\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "54ac4503-ef31-45e7-9266-69554fcbb7e3", "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\": \"ACTIVE\",\n \"label\": \"string\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "f18cb6a6-2cb0-4ac5-b7a8-643b462a6053", "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\": \"LOST\",\n \"label\": \"string\"\n },\n {\n \"value\": \"ACTIVE\",\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\": \"WON\",\n \"label\": \"string\"\n },\n {\n \"value\": \"LOST\",\n \"label\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8717d039-16dd-451d-8a2c-d2732861ce87", "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": "51e10a01-06e5-4df3-aa95-30c334745717", "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": "566852db-27d4-4f06-8a82-fd60441d29ae", "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" }, { "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": "3a444b26-ddf8-48d0-90dd-da812d21a0b8", "name": "a Mono emitting the count of deals", "originalRequest": { "url": { "path": [ "v2", "pipelines", "{{id}}:dealsCount" ], "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": "7717", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "b289caf4-75f1-4341-8faa-07fb748dcc20", "name": "Stages", "description": { "content": "Stages endpoints.", "type": "text/plain" }, "item": [ { "id": "a67cc8e9-1efb-4fd9-938b-24db658267f8", "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": "515f79db-fd5b-4166-a714-93c1aeb43469", "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": "7d069949-015a-4933-97fd-959c34120186", "name": "Create Stages", "request": { "name": "Create Stages", "description": { "content": "Creates a new entity.", "type": "text/plain" }, "url": { "path": [ "v2", "stages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"pipeline_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "98fb23bd-f073-454b-a693-d42c84ea91b5", "name": "The created entity", "originalRequest": { "url": { "path": [ "v2", "stages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"pipeline_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"name\": \"string\",\n \"pipeline_id\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c3cd1653-3108-4a58-9003-c7e47a965959", "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": "c515c9ef-eab4-457e-b611-6fe4181153d0", "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": "122c0e3a-305f-42e8-b8b7-d1070eb2b138", "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": "4e35afe9-e6f4-4809-8bf6-8519f1293012", "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": "eae90016-2042-434f-856f-3108423631dd", "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": "f1c75720-6605-4312-badf-25b87c506889", "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": "c43d2f5b-69bf-4fb4-a517-a38a8a6a8725", "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": "cdce97b0-2eb0-41b0-8dc4-d13c3e02f780", "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": "7717", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e3715abc-a1d4-4409-93b2-63a75535f593", "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": "405d9acd-c103-4029-a7bb-1c8cbc1345ec", "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\": 6906.344299769001,\n \"currency\": \"string\"\n },\n \"contact_ids\": [\n \"string\",\n \"string\"\n ],\n \"stage_id\": \"string\",\n \"stage_assignment_time\": \"2024-10-28T14:37:47.903Z\",\n \"owner_ids\": [\n \"string\",\n \"string\"\n ],\n \"task_ids\": [\n \"string\",\n \"string\"\n ],\n \"order_id\": \"string\",\n \"status\": \"string\",\n \"estimated_close_time\": \"2024-06-06T19:04:26.803Z\",\n \"closed_time\": \"1979-11-19T09:19:05.852Z\",\n \"custom_fields\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n }\n },\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"value\": {\n \"amount\": 7340.151862617097,\n \"currency\": \"string\"\n },\n \"contact_ids\": [\n \"string\",\n \"string\"\n ],\n \"stage_id\": \"string\",\n \"stage_assignment_time\": \"1978-10-09T23:30:06.553Z\",\n \"owner_ids\": [\n \"string\",\n \"string\"\n ],\n \"task_ids\": [\n \"string\",\n \"string\"\n ],\n \"order_id\": \"string\",\n \"status\": \"string\",\n \"estimated_close_time\": \"1963-11-27T07:14:08.779Z\",\n \"closed_time\": \"1955-12-17T23:58:42.242Z\",\n \"custom_fields\": {\n \"key_0\": true\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] } ], "event": [], "variable": [ { "type": "string", "value": "https://api-intg.infusiontest.com/services", "key": "baseUrl" }, { "disabled": false, "description": { "content": "(Required) the pipeline identifier", "type": "text/plain" }, "type": "any", "value": "string", "key": "id" } ], "info": { "_postman_id": "ef018f7d-02c8-4f96-8dd8-258ffea5ce04", "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" } } }