{ "item": [ { "id": "5a1990ec-acb7-4ea4-b996-4a627a8ec657", "name": "Custom Fields", "description": { "content": "Custom Fields endpoints.", "type": "text/plain" }, "item": [ { "id": "c5b94bd6-2834-4453-9d7d-db7a584f5d13", "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": "daee4e48-095f-4daf-9d97-a38c1a0b2779", "name": "a list of PipelineCustomFields", "originalRequest": { "url": { "path": [ "v2", "customFields" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" }, { "key": "page_size", "value": "100" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"custom_fields\": [\n {\n \"default_value\": {},\n \"id\": \"string\",\n \"name\": \"string\",\n \"type\": {\n \"discriminator\": {\n \"description\": \"The discriminator for the model property type. This field is required.\",\n \"value\": \"\"\n },\n \"primitive_type\": {\n \"description\": \"The base primitive type of the custom field. This field is required.\",\n \"value\": \"\"\n },\n \"array\": {\n \"description\": \"The array property type of the custom field. This field is optional.\",\n \"nullable\": true,\n \"value\": \"\"\n },\n \"ref\": {\n \"description\": \"The reference property type of the custom field. This field is optional.\",\n \"nullable\": true,\n \"value\": \"\"\n }\n },\n \"label\": \"string\",\n \"description\": \"string\",\n \"helper_text\": \"string\",\n \"validators\": [\n {\n \"required\": false,\n \"size\": {\n \"description\": \"The size validator for the custom field. This field is required.\",\n \"value\": \"\"\n }\n },\n {\n \"required\": false,\n \"size\": {\n \"description\": \"The size validator for the custom field. This field is required.\",\n \"value\": \"\"\n }\n }\n ],\n \"display_options\": {\n \"hidden\": 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\": false,\n \"size\": {\n \"description\": \"The size validator for the custom field. This field is required.\",\n \"value\": \"\"\n }\n },\n {\n \"required\": false,\n \"size\": {\n \"description\": \"The size validator for the custom field. This field is required.\",\n \"value\": \"\"\n }\n }\n ],\n \"display_options\": {\n \"hidden\": false,\n \"type\": {\n \"description\": \"The type of display options. This field is required.\",\n \"value\": \"\"\n },\n \"array_display_options\": {\n \"description\": \"The display options for array type custom fields. This field is optional.\",\n \"value\": \"\"\n },\n \"reference_type_display_options\": {\n \"description\": \"The display options for reference type custom fields. This field is optional.\",\n \"value\": \"\"\n },\n \"date_time_display_options\": {\n \"description\": \"The display options for date and time type custom fields. This field is optional.\",\n \"value\": \"\"\n },\n \"boolean_display_options\": {\n \"description\": \"The display options for boolean type custom fields. This field is optional.\",\n \"value\": \"\"\n },\n \"duration\": {\n \"description\": \"The display options for duration type custom fields. This field is optional.\",\n \"value\": \"\"\n }\n },\n \"options\": {\n \"display_type\": {\n \"description\": \"The display type of the custom field options. This field is required.\",\n \"value\": \"\"\n },\n \"groups\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"default_option_id\": \"string\",\n \"option_source\": {\n \"description\": \"The source of the custom field options. This field is optional.\",\n \"nullable\": true,\n \"value\": \"\"\n }\n }\n }\n ],\n \"next_page_token\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b6ea59e7-cf43-4714-b0ce-1ebc6a24a747", "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\": \"va3l8iu\",\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\": \"ARRAY\",\n \"array_display_options\": {\n \"item_options\": {\n \"description\": \"Display options for the items in the array. This field is required.\",\n \"value\": \"\"\n },\n \"sortable\": true\n },\n \"reference_type_display_options\": {\n \"hidden\": true,\n \"card_options\": {\n \"card_properties\": {\n \"value\": \"\"\n }\n },\n \"title_property\": \"string\",\n \"description_property\": \"string\",\n \"reference_display_type\": \"DROPDOWN\",\n \"empty_state\": {\n \"description\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n },\n \"component_name\": \"string\"\n },\n \"date_time_display_options\": {\n \"allow_past_dates\": true,\n \"allow_future_dates\": false\n },\n \"boolean_display_options\": {\n \"display_type\": \"TOGGLE\"\n },\n \"duration\": {\n \"duration_units\": [\n \"MONTHS\",\n \"DAYS\"\n ]\n }\n },\n \"options\": {\n \"display_type\": \"RADIO\",\n \"groups\": [\n {\n \"options\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"sort_order\": {\n \"value\": \"\"\n },\n \"subtitle\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"sort_order\": {\n \"value\": \"\"\n },\n \"subtitle\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n }\n ],\n \"sort_order\": 8418,\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\": 7921,\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\": 8198,\n \"size_type\": \"MIN\"\n }\n },\n {\n \"required\": true,\n \"size\": {\n \"size\": 4577,\n \"size_type\": \"MAX\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "5fddd4b4-6db8-4b8a-b7f9-f2a96e7ad964", "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\": \"qNs_\",\n \"type\": {\n \"discriminator\": \"REF\",\n \"primitive_type\": \"DATETIME\",\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\": \"REF\",\n \"array_display_options\": {\n \"item_options\": {\n \"description\": \"Display options for the items in the array. This field is required.\",\n \"value\": \"\"\n },\n \"sortable\": false\n },\n \"reference_type_display_options\": {\n \"hidden\": true,\n \"card_options\": {\n \"card_properties\": {\n \"value\": \"\"\n }\n },\n \"title_property\": \"string\",\n \"description_property\": \"string\",\n \"reference_display_type\": \"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\": true\n },\n \"boolean_display_options\": {\n \"display_type\": \"TOGGLE\"\n },\n \"duration\": {\n \"duration_units\": [\n \"MONTHS\",\n \"DAYS\"\n ]\n }\n },\n \"options\": {\n \"display_type\": \"RADIO\",\n \"groups\": [\n {\n \"options\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"sort_order\": {\n \"value\": \"\"\n },\n \"subtitle\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"sort_order\": {\n \"value\": \"\"\n },\n \"subtitle\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n }\n ],\n \"sort_order\": 2034,\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\": 5249,\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\": 7385,\n \"size_type\": \"MIN\"\n }\n },\n {\n \"required\": false,\n \"size\": {\n \"size\": 1664,\n \"size_type\": \"MIN\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"default_value\": {},\n \"id\": \"string\",\n \"name\": \"string\",\n \"type\": {\n \"discriminator\": \"ARRAY\",\n \"primitive_type\": \"SEMVER\",\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\": 2953,\n \"size_type\": \"MAX\"\n }\n },\n {\n \"required\": true,\n \"size\": {\n \"size\": 6479,\n \"size_type\": \"MAX\"\n }\n }\n ],\n \"display_options\": {\n \"hidden\": true,\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\": \"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\": true\n },\n \"boolean_display_options\": {\n \"display_type\": \"TOGGLE_BUTTON\"\n },\n \"duration\": {\n \"duration_units\": [\n \"HOURS\",\n \"MONTHS\"\n ]\n }\n },\n \"options\": {\n \"display_type\": \"DROPDOWN\",\n \"groups\": [\n {\n \"options\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"sort_order\": {\n \"value\": \"\"\n },\n \"subtitle\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"sort_order\": {\n \"value\": \"\"\n },\n \"subtitle\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n }\n ],\n \"sort_order\": 5515,\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\": 365,\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": "b71c5ff9-ba48-450d-bae6-8e82e2ea044b", "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": "26f975ed-ac9b-42b9-aff9-0b501d7bc7b9", "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": "27b1a5bd-9c5d-4003-94c7-d6833ff04605", "name": "Updates a custom field", "request": { "name": "Updates a custom field", "description": { "content": "Updates a custom field", "type": "text/plain" }, "url": { "path": [ "v2", "customFields", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the identifier of the custom field to update" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"label\": \"string\",\n \"description\": \"string\",\n \"hint\": \"string\",\n \"helper_text\": \"string\",\n \"default_value\": {},\n \"display_options\": {\n \"hidden\": true,\n \"type\": \"REF\",\n \"array_display_options\": {\n \"item_options\": {\n \"description\": \"Display options for the items in the array. This field is required.\",\n \"value\": \"\"\n },\n \"sortable\": false\n },\n \"reference_type_display_options\": {\n \"hidden\": true,\n \"card_options\": {\n \"card_properties\": {\n \"value\": \"\"\n }\n },\n \"title_property\": \"string\",\n \"description_property\": \"string\",\n \"reference_display_type\": \"DROPDOWN\",\n \"empty_state\": {\n \"description\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n },\n \"component_name\": \"string\"\n },\n \"date_time_display_options\": {\n \"allow_past_dates\": false,\n \"allow_future_dates\": false\n },\n \"boolean_display_options\": {\n \"display_type\": \"TOGGLE\"\n },\n \"duration\": {\n \"duration_units\": [\n \"HOURS\",\n \"DAYS\"\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\": 5952,\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\": 641,\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\": 2226,\n \"size_type\": \"MIN\"\n }\n },\n {\n \"required\": true,\n \"size\": {\n \"size\": 1902,\n \"size_type\": \"MAX\"\n }\n }\n ],\n \"deleted\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "19f1aebd-827d-4e82-9b52-81d362dc06c0", "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\": \"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\": 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\": true\n },\n \"boolean_display_options\": {\n \"display_type\": \"CHECKBOX\"\n },\n \"duration\": {\n \"duration_units\": [\n \"YEARS\",\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\": 3967,\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\": 2093,\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\": 3262,\n \"size_type\": \"MAX\"\n }\n },\n {\n \"required\": true,\n \"size\": {\n \"size\": 3751,\n \"size_type\": \"MAX\"\n }\n }\n ],\n \"deleted\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"default_value\": {},\n \"id\": \"string\",\n \"name\": \"string\",\n \"type\": {\n \"discriminator\": \"ARRAY\",\n \"primitive_type\": \"SEMVER\",\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\": 2953,\n \"size_type\": \"MAX\"\n }\n },\n {\n \"required\": true,\n \"size\": {\n \"size\": 6479,\n \"size_type\": \"MAX\"\n }\n }\n ],\n \"display_options\": {\n \"hidden\": true,\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\": \"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\": true\n },\n \"boolean_display_options\": {\n \"display_type\": \"TOGGLE_BUTTON\"\n },\n \"duration\": {\n \"duration_units\": [\n \"HOURS\",\n \"MONTHS\"\n ]\n }\n },\n \"options\": {\n \"display_type\": \"DROPDOWN\",\n \"groups\": [\n {\n \"options\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"sort_order\": {\n \"value\": \"\"\n },\n \"subtitle\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"sort_order\": {\n \"value\": \"\"\n },\n \"subtitle\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n }\n }\n ],\n \"sort_order\": 5515,\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\": 365,\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": "172d0d3f-b6fa-4178-b771-b0cfb9347a57", "name": "DateExpression", "description": { "content": "DateExpression endpoints.", "type": "text/plain" }, "item": [ { "id": "08f1ce05-1055-45ce-8eb5-e03206167fb9", "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": "1c316fb7-1c2b-4b73-8298-493e8886dee8", "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\": 2637,\n \"parse_start\": 5761,\n \"query\": \"string\",\n \"recurring\": true,\n \"recurse_until\": {\n \"dates\": [\n \"2003-04-28T18:27:30.325Z\",\n \"2020-10-10T20:02:59.170Z\"\n ],\n \"chain\": \"string\"\n },\n \"result\": {\n \"dates\": [\n \"2022-07-28T05:10:27.926Z\",\n \"1983-10-15T14:05:55.631Z\"\n ],\n \"chain\": \"string\"\n },\n \"time_inferred\": false,\n \"complete_match\": false\n },\n {\n \"date_inferred\": false,\n \"parse_end\": 8402,\n \"parse_start\": 8179,\n \"query\": \"string\",\n \"recurring\": false,\n \"recurse_until\": {\n \"dates\": [\n \"1998-01-29T06:05:24.013Z\",\n \"1951-10-21T11:52:36.265Z\"\n ],\n \"chain\": \"string\"\n },\n \"result\": {\n \"dates\": [\n \"1949-07-27T14:52:56.289Z\",\n \"1948-12-05T19:55:35.870Z\"\n ],\n \"chain\": \"string\"\n },\n \"time_inferred\": false,\n \"complete_match\": false\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "b60b185a-2ca9-476e-8090-e1f3c0902a48", "name": "Deals", "description": { "content": "Deals endpoints.", "type": "text/plain" }, "item": [ { "id": "0351bafc-7f53-475a-a032-33723856d249", "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": "2e8418c7-8070-4530-8fe4-754860dda268", "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\": 4460.763094869698,\n \"currency\": \"string\"\n },\n \"contact_ids\": [\n \"string\",\n \"string\"\n ],\n \"stage_id\": \"string\",\n \"stage_assignment_time\": \"1995-09-23T03:02:54.865Z\",\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\": \"2012-06-10T16:10:41.714Z\",\n \"closed_time\": \"2009-11-17T21:49:58.814Z\",\n \"custom_fields\": {\n \"key_0\": 8194,\n \"key_1\": true\n }\n },\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"value\": {\n \"amount\": 6894.145135040501,\n \"currency\": \"string\"\n },\n \"contact_ids\": [\n \"string\",\n \"string\"\n ],\n \"stage_id\": \"string\",\n \"stage_assignment_time\": \"1963-10-12T16:27:48.305Z\",\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-03-12T03:34:03.205Z\",\n \"closed_time\": \"2015-01-14T08:04:17.938Z\",\n \"custom_fields\": {\n \"key_0\": \"string\",\n \"key_1\": true\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8ef0a575-c2dc-4d0c-b25c-a4506445361c", "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\": false,\n \"id\": \"string\"\n }\n ],\n \"name\": \"string\",\n \"owners\": [\n {\n \"id\": \"string\"\n },\n {\n \"id\": \"string\"\n }\n ],\n \"stage_id\": \"string\",\n \"status\": \"string\",\n \"task_ids\": [\n \"string\",\n \"string\"\n ],\n \"value\": {\n \"amount\": 9964.233614152032,\n \"currency\": \"string\"\n },\n \"owner_id\": \"string\",\n \"estimated_close_time\": \"1963-05-05T03:07:15.597Z\",\n \"custom_fields\": {\n \"key_0\": 6888\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "123bbcab-3f74-412c-a51e-5962f1a1ec41", "name": "The created entity", "originalRequest": { "url": { "path": [ "v2", "deals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contacts\": [\n {\n \"primary_contact\": true,\n \"id\": \"string\"\n },\n {\n \"primary_contact\": false,\n \"id\": \"string\"\n }\n ],\n \"name\": \"string\",\n \"owners\": [\n {\n \"id\": \"string\"\n },\n {\n \"id\": \"string\"\n }\n ],\n \"stage_id\": \"string\",\n \"status\": \"string\",\n \"task_ids\": [\n \"string\",\n \"string\"\n ],\n \"value\": {\n \"amount\": 2142.233665492095,\n \"currency\": \"string\"\n },\n \"owner_id\": \"string\",\n \"estimated_close_time\": \"1952-09-01T21:26:31.527Z\",\n \"custom_fields\": {\n \"key_0\": \"string\",\n \"key_1\": false\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\": 4485.015258418199,\n \"currency\": \"string\"\n },\n \"contact_ids\": [\n \"string\",\n \"string\"\n ],\n \"stage_id\": \"string\",\n \"stage_assignment_time\": \"1949-01-03T17:29:39.695Z\",\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\": \"1959-04-27T18:49:59.432Z\",\n \"closed_time\": \"1989-03-10T06:06:09.238Z\",\n \"custom_fields\": {\n \"key_0\": \"string\",\n \"key_1\": 6783,\n \"key_2\": 4331.044180926345\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "821ba404-0587-4832-ba50-5453f07faa15", "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": "348bfe12-f3f1-4640-a498-dc1a75ad2de3", "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\": 6932.285901295357,\n \"currency\": \"string\"\n },\n \"contact_ids\": [\n \"string\",\n \"string\"\n ],\n \"stage_id\": \"string\",\n \"stage_assignment_time\": \"1954-06-04T20:15:50.608Z\",\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\": \"1991-07-25T22:41:57.571Z\",\n \"closed_time\": \"1982-12-28T12:30:11.496Z\",\n \"custom_fields\": {\n \"key_0\": 9977,\n \"key_1\": 462\n }\n },\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"value\": {\n \"amount\": 6895.949488430455,\n \"currency\": \"string\"\n },\n \"contact_ids\": [\n \"string\",\n \"string\"\n ],\n \"stage_id\": \"string\",\n \"stage_assignment_time\": \"1970-02-24T23:22:51.709Z\",\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\": \"1958-10-05T20:17:50.269Z\",\n \"closed_time\": \"2019-01-18T19:15:15.609Z\",\n \"custom_fields\": {\n \"key_0\": 2905.4563856726845,\n \"key_1\": \"string\"\n }\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bca46b8f-40d7-4e39-a596-95f8b639dbff", "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": "f138646a-222d-4325-8555-65549ad1abf4", "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": "ee5b0b88-38b2-4212-b20a-f69438c50f33", "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": "350e7a3e-21f7-49b7-b5ba-c013227687ad", "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\": 2783.2021817390396,\n \"currency\": \"string\"\n },\n \"contact_ids\": [\n \"string\",\n \"string\"\n ],\n \"stage_id\": \"string\",\n \"stage_assignment_time\": \"1985-06-26T04:12:33.073Z\",\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\": \"1977-09-24T06:09:40.488Z\",\n \"closed_time\": \"1971-03-09T15:37:01.837Z\",\n \"custom_fields\": {\n \"key_0\": \"string\",\n \"key_1\": 4835\n }\n },\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"value\": {\n \"amount\": 4628.708893147744,\n \"currency\": \"string\"\n },\n \"contact_ids\": [\n \"string\",\n \"string\"\n ],\n \"stage_id\": \"string\",\n \"stage_assignment_time\": \"1977-10-24T01:12:18.694Z\",\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\": \"2023-07-06T08:22:05.991Z\",\n \"closed_time\": \"1997-03-16T19:21:41.291Z\",\n \"custom_fields\": {\n \"key_0\": true\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "56911ead-7d01-4136-b430-fad1970a87e6", "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": "758a2578-59b6-4a10-9902-71939aa8341f", "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\": \"2008-08-10T10:12:57.865Z\",\n \"modified_time\": \"1971-04-09T17:31:44.150Z\",\n \"create_success\": true,\n \"error_message\": \"string\"\n },\n {\n \"id\": \"string\",\n \"body\": \"string\",\n \"deal_id\": \"string\",\n \"created_by\": \"string\",\n \"created_time\": \"1965-07-29T18:11:58.469Z\",\n \"modified_time\": \"1967-10-25T05:57:30.928Z\",\n \"create_success\": false,\n \"error_message\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0ebd94dc-6bd2-42a2-b32e-2db816ae04c4", "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": "6cc587d5-cf88-487b-8bd2-d2de16c6567d", "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\": \"1978-05-11T20:26:13.202Z\",\n \"modified_time\": \"1995-09-15T08:39:16.278Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "79208c01-bc19-4636-a022-dcb3287a5f66", "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": "06ace60d-0058-4722-9eae-085fc451a60d", "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": "9acc6379-ebc3-4f38-945e-760dded48172", "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": "044571ee-a4bc-4d4a-b47a-8641d9a949c5", "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\": \"1978-05-11T20:26:13.202Z\",\n \"modified_time\": \"1995-09-15T08:39:16.278Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f2f82d3a-ba83-456b-8571-d9708867c585", "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\": \"strin\",\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\": 3161.2366643688983,\n \"currency\": \"string\"\n },\n \"owner_id\": \"string\",\n \"estimated_close_time\": \"1958-02-27T10:08:18.827Z\",\n \"custom_fields\": {\n \"key_0\": 8152\n }\n },\n {\n \"contacts\": [\n {\n \"primary_contact\": true,\n \"id\": \"string\"\n },\n {\n \"primary_contact\": false,\n \"id\": \"string\"\n }\n ],\n \"external_system_id\": \"string\",\n \"name\": \"string\",\n \"owners\": [\n {\n \"id\": \"string\"\n },\n {\n \"id\": \"string\"\n }\n ],\n \"stage_id\": \"string\",\n \"status\": \"string\",\n \"task_ids\": [\n \"string\",\n \"string\"\n ],\n \"value\": {\n \"amount\": 4487.088767650045,\n \"currency\": \"string\"\n },\n \"owner_id\": \"string\",\n \"estimated_close_time\": \"2017-12-24T07:44:51.806Z\",\n \"custom_fields\": {\n \"key_0\": false\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "acac29c2-5c4c-4d74-abb4-106172f494ad", "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\": 877.5779867834243,\n \"currency\": \"string\"\n },\n \"owner_id\": \"string\",\n \"estimated_close_time\": \"2002-09-20T09:31:59.540Z\",\n \"custom_fields\": {\n \"key_0\": 6649.617494998841,\n \"key_1\": true\n }\n },\n {\n \"contacts\": [\n {\n \"primary_contact\": true,\n \"id\": \"string\"\n },\n {\n \"primary_contact\": false,\n \"id\": \"string\"\n }\n ],\n \"external_system_id\": \"string\",\n \"name\": \"string\",\n \"owners\": [\n {\n \"id\": \"string\"\n },\n {\n \"id\": \"string\"\n }\n ],\n \"stage_id\": \"string\",\n \"status\": \"string\",\n \"task_ids\": [\n \"string\",\n \"string\"\n ],\n \"value\": {\n \"amount\": 8973.983553631491,\n \"currency\": \"string\"\n },\n \"owner_id\": \"string\",\n \"estimated_close_time\": \"2020-08-06T14:16:03.205Z\",\n \"custom_fields\": {\n \"key_0\": 5795.876397669282,\n \"key_1\": 8084.9521070345445\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 }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "40718fb9-8436-4917-9d12-0ba598728293", "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": "501881c5-2949-4b1d-bf5f-a5d567d55e3c", "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": "6a8c4e3a-6d84-483a-b1de-d56ec33c8d51", "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": "b0762dfb-6896-435a-9f76-7f9c7c72ccf5", "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\": 4485.015258418199,\n \"currency\": \"string\"\n },\n \"contact_ids\": [\n \"string\",\n \"string\"\n ],\n \"stage_id\": \"string\",\n \"stage_assignment_time\": \"1949-01-03T17:29:39.695Z\",\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\": \"1959-04-27T18:49:59.432Z\",\n \"closed_time\": \"1989-03-10T06:06:09.238Z\",\n \"custom_fields\": {\n \"key_0\": \"string\",\n \"key_1\": 6783,\n \"key_2\": 4331.044180926345\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "66c3eab8-d745-43e6-b393-361af5ca4fe0", "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": "15af3228-ea00-4ac5-9863-2e4aaf78bf93", "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": "22221418-fd98-4761-a757-0a6d5264be87", "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\": 5332.349957441871,\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\": \"string\",\n \"estimated_close_date\": \"2015-05-09T08:37:18.524Z\",\n \"closed_date\": \"2023-05-10T04:46:53.249Z\",\n \"custom_fields\": {\n \"key_0\": 231.42050545493342,\n \"key_1\": 371.7854095547124\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "3f8fe955-8711-4621-902f-af24a0b87897", "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\": 4973.657777335916,\n \"currency_code\": \"string\",\n \"contacts\": [\n {\n \"primary_contact\": true,\n \"id\": \"string\"\n },\n {\n \"primary_contact\": false,\n \"id\": \"string\"\n }\n ],\n \"owners\": [\n {\n \"id\": \"string\"\n },\n {\n \"id\": \"string\"\n }\n ],\n \"owner_id\": \"string\",\n \"task_ids\": [\n \"string\",\n \"string\"\n ],\n \"previous_deal_id\": \"string\",\n \"next_deal_id\": \"string\",\n \"estimated_close_date\": \"1974-08-15T05:25:14.106Z\",\n \"closed_date\": \"2017-11-29T07:48:40.411Z\",\n \"custom_fields\": {\n \"key_0\": 1098.3442071112504\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\": 4485.015258418199,\n \"currency\": \"string\"\n },\n \"contact_ids\": [\n \"string\",\n \"string\"\n ],\n \"stage_id\": \"string\",\n \"stage_assignment_time\": \"1949-01-03T17:29:39.695Z\",\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\": \"1959-04-27T18:49:59.432Z\",\n \"closed_time\": \"1989-03-10T06:06:09.238Z\",\n \"custom_fields\": {\n \"key_0\": \"string\",\n \"key_1\": 6783,\n \"key_2\": 4331.044180926345\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "216bc813-f8a6-4b75-9f5e-db6dab991740", "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\": 5060,\n \"key_1\": false,\n \"key_2\": 2194,\n \"key_3\": 393.6096604464656\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "bd7da269-ebaa-44ca-a6cd-7b5a22f6a1fe", "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\": 5060,\n \"key_1\": false,\n \"key_2\": 2194,\n \"key_3\": 393.6096604464656\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": "cfdd41e7-9f81-4974-9b73-fc9181b9ff5e", "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": "9e43bfe0-fcd0-43aa-aebd-ea723509efea", "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\": \"1962-10-18T16:58:32.163Z\",\n \"modified_time\": \"1987-08-30T12:27:40.605Z\"\n },\n {\n \"id\": \"string\",\n \"deal_id\": \"string\",\n \"body\": \"string\",\n \"created_by\": \"string\",\n \"created_time\": \"2019-09-12T10:34:58.594Z\",\n \"modified_time\": \"2020-05-15T15:29:13.558Z\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c5d58435-25e8-481f-b2fd-390e3d037d8e", "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": "5a337da9-1b09-4779-a6ce-03b9542a40eb", "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\": \"1978-05-11T20:26:13.202Z\",\n \"modified_time\": \"1995-09-15T08:39:16.278Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b4bdba46-7b4c-4493-a6df-9fa9d8ac99e6", "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": "bff00d3c-74dc-4e0e-a37d-f04852ed780d", "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": "7620", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d72531e1-0167-46a5-8b54-4e2969b48182", "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": "1ac49af3-18f1-4c59-8176-d7b8dfd6aabd", "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": "6ccf3d7d-232b-4797-9e53-f228db213bd5", "name": "Display Forms", "description": { "content": "Display Forms endpoints.", "type": "text/plain" }, "item": [ { "id": "97f216a5-0e45-42dd-9ab5-f037a7baa353", "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": "d0af3133-286f-47c8-8280-8ca9da442666", "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\": 1433,\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\": 7515,\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": "021cc630-ce05-4d50-9a45-b05bd854a4a2", "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\": 2375,\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\": 5999,\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\": 8385,\n \"description\": \"string\"\n },\n {\n \"properties\": [\n {\n \"source\": \"CUSTOM\",\n \"sort_order\": 8983,\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\": 4655,\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\": 7621,\n \"description\": \"string\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "0bf3e4d7-4ba1-479b-aa79-3f747c551a8c", "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\": 4502,\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\": 5867,\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\": 6927,\n \"description\": \"string\"\n },\n {\n \"properties\": [\n {\n \"source\": \"CUSTOM\",\n \"sort_order\": 9736,\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\": 5909,\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\": 6526,\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\": 2939,\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\": 1998,\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}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "bbc821d3-00c2-4b87-924f-b191341896ab", "name": "Pipelines", "description": { "content": "Pipelines endpoints.", "type": "text/plain" }, "item": [ { "id": "a724cb28-bb21-4f4c-ac97-08db015bcbee", "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": "156ec2ff-5ffe-4eb0-acb5-18fd4c6c7472", "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": "7a6a238d-5e1f-4499-b4d5-b61117b4e5f3", "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": "e8108215-1440-452a-8354-6cd1c9710135", "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": "9cef8a0a-c32d-4195-aaa1-7e3d049f5da1", "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": "47320c94-cce5-479b-9db2-3af4829fa85b", "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\": \"740571820\",\n \"stat_total_deal_count\": 1652,\n \"stat_new_deal_count\": 6763\n },\n {\n \"pipeline_name\": \"string\",\n \"pipeline_id\": \"671\",\n \"stat_total_deal_count\": 475,\n \"stat_new_deal_count\": 5155\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b72ac338-a606-4410-b456-2d31f91a68b2", "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": "174ac648-af58-4e36-a840-260a2e2d7ac6", "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": "2cdb65fb-cd3f-472f-95cd-00b5d4805b6b", "name": "Deletes a pipeline.", "request": { "name": "Deletes a pipeline.", "description": { "content": "Deletes a pipeline.", "type": "text/plain" }, "url": { "path": [ "v2", "pipelines", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "new_stage_id", "value": "string", "description": "the new stage identifier, can be null" }, { "disabled": false, "key": "allow_cleanup", "value": "false", "description": "flag indicating whether cleanup is allowed, can be null" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the pipeline identifier" } ] }, "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "7990c8ef-6d6b-4310-8205-4973dac662b3", "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": "3cc2beda-1902-4fef-aabf-2cef6dd9bcd1", "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": "13896f23-a1cf-47a7-a8de-758ed4ff9cee", "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": "088e40d3-ddf3-4b9e-a7a9-8bdc1e437e18", "name": "Updates a pipeline's deals in bulk.", "request": { "name": "Updates a pipeline's deals in bulk.", "description": { "content": "Updates a pipeline's deals in bulk.", "type": "text/plain" }, "url": { "path": [ "v2", "pipelines", ":id", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the pipeline ID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"bulk_deal_update_type\": \"string\",\n \"exclude_deal_ids_specified\": false,\n \"filters\": [\n {\n \"key\": \"string\",\n \"operator\": \"GREATER_THAN\",\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": "a85b24c1-8bfc-4c62-bef6-655f1b90d08a", "name": "the response containing the results of the bulk update operation", "originalRequest": { "url": { "path": [ "v2", "pipelines", ":id", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the pipeline ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"bulk_deal_update_type\": \"string\",\n \"exclude_deal_ids_specified\": false,\n \"filters\": [\n {\n \"key\": \"string\",\n \"operator\": \"LESS_THAN_OR_EQUAL\",\n \"value\": \"string\"\n },\n {\n \"key\": \"string\",\n \"operator\": \"EQUALS\",\n \"value\": \"string\"\n }\n ],\n \"new_value\": \"string\",\n \"deal_ids\": [\n \"string\",\n \"string\",\n \"string\",\n \"string\",\n \"string\",\n \"string\",\n \"string\",\n \"string\",\n \"string\",\n \"string\",\n \"string\",\n \"string\",\n \"string\",\n \"string\",\n \"string\",\n \"string\",\n \"string\",\n \"string\",\n \"string\",\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "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": "30bd343a-63cc-44fc-a47b-e1ff6d4594d1", "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": "6ea349c2-1a11-44df-863c-2857bebab74c", "name": "a Mono emitting the count of deals", "originalRequest": { "url": { "path": [ "v2", "pipelines", ":id", "deals" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter", "value": "string" }, { "key": "page_size", "value": "100" }, { "key": "page_token", "value": "string" }, { "key": "order_by", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the pipeline identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"next_page_token\": \"string\",\n \"deals\": [\n {\n \"name\": \"string\",\n \"id\": \"string\",\n \"value\": {\n \"amount\": 4524.291240101453,\n \"currency\": \"string\"\n },\n \"stage_id\": \"string\",\n \"stage_name\": \"string\",\n \"stage_assignment_time\": \"1948-08-28T01:05:02.738Z\",\n \"close_time\": \"1951-01-04T13:16:19.730Z\",\n \"estimated_close_time\": \"1958-01-18T21:47:34.025Z\",\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 \"name\": \"string\",\n \"id\": \"string\",\n \"value\": {\n \"amount\": 3643.464592163763,\n \"currency\": \"string\"\n },\n \"stage_id\": \"string\",\n \"stage_name\": \"string\",\n \"stage_assignment_time\": \"2011-06-05T08:26:16.032Z\",\n \"close_time\": \"1964-02-14T23:09:24.036Z\",\n \"estimated_close_time\": \"2012-08-06T08:32:48.444Z\",\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": "c9a2245a-17e9-4070-94b0-c6047eece3ed", "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": "813c2390-d0bf-4221-83eb-c1d07b26a2b8", "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\": \"LOST\",\n \"label\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "667e796f-9d0c-4298-bc44-126d2ce6fe38", "name": "Sets the outcome labels for a pipeline.", "request": { "name": "Sets the outcome labels for a pipeline.", "description": { "content": "Sets the outcome labels for a pipeline.", "type": "text/plain" }, "url": { "path": [ "v2", "pipelines", ":id", "outcomes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) the pipeline identifier" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"outcome_labels\": [\n {\n \"value\": \"ACTIVE\",\n \"label\": \"string\"\n },\n {\n \"value\": \"LOST\",\n \"label\": \"string\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "e2d62611-529d-4ea9-9a56-7db94fbecf92", "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\": \"WON\",\n \"label\": \"string\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"next_page_token\": \"string\",\n \"outcome_labels\": [\n {\n \"value\": \"ACTIVE\",\n \"label\": \"string\"\n },\n {\n \"value\": \"WON\",\n \"label\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "293783cc-fa6b-48b2-bac6-ce8eb89db496", "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": "8225eb07-900f-4780-bb08-16dd2d55876c", "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": "8317baff-b013-437c-afcb-114515158efd", "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": "a12e7c9c-bcc5-4cfb-86a8-4b0befbe5da9", "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": "7620", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "efba8178-9c43-45a3-b29b-95bc817e6eab", "name": "Stages", "description": { "content": "Stages endpoints.", "type": "text/plain" }, "item": [ { "id": "db0826c8-38c3-4e2c-9612-b182529690f7", "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": "79169dd5-0c3d-4819-bf8c-8af3449fe418", "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": "21270c94-f6ba-44eb-88e0-d6c96f4f35ac", "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": "22c39517-faa0-4f95-9162-1def00e635b0", "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": "1f0c6def-0330-4638-b9c3-45b5f497355c", "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": "75593b07-4569-4afe-a5a3-2a98dcd8e5cf", "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": "413f6801-3731-4668-a0fe-fa319c60655a", "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": "35f18ffa-6509-4242-ae0a-2a75d2e31127", "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": "25dcb970-fe65-4976-ad63-f71346756d1e", "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": "7a812583-e283-49b7-88d1-c09b29c2d2cc", "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": "13114207-7f8b-4818-81b2-6271ffad1a92", "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": "7d7a4063-a6bb-43df-9a63-43fc995c472d", "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": "7620", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b8515132-c386-40f3-9bcf-52c1ae1f0637", "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": "6aa7ec3c-9ba8-401b-8bef-8def87f5a4a9", "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\": 8624.19989012982,\n \"currency\": \"string\"\n },\n \"contact_ids\": [\n \"string\",\n \"string\"\n ],\n \"stage_id\": \"string\",\n \"stage_assignment_time\": \"2011-03-06T14:10:34.832Z\",\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-05-08T07:45:48.750Z\",\n \"closed_time\": \"1966-04-30T08:53:56.770Z\",\n \"custom_fields\": {\n \"key_0\": 142.4968780920266,\n \"key_1\": \"string\"\n }\n },\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"value\": {\n \"amount\": 7379.555913542761,\n \"currency\": \"string\"\n },\n \"contact_ids\": [\n \"string\",\n \"string\"\n ],\n \"stage_id\": \"string\",\n \"stage_assignment_time\": \"1970-09-25T08:48:25.777Z\",\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\": \"1984-03-01T22:39:14.641Z\",\n \"closed_time\": \"2017-03-10T08:14:35.807Z\",\n \"custom_fields\": {\n \"key_0\": 8427\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] } ], "event": [], "variable": [ { "type": "string", "value": "https://api.infusionsoft.com/services", "key": "baseUrl" }, { "disabled": false, "description": { "content": "(Required) the pipeline identifier", "type": "text/plain" }, "type": "any", "value": "string", "key": "id" } ], "info": { "_postman_id": "d14fcd48-d9ea-4c05-8f8c-391b1e64cecc", "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" } } }