{ "info": { "_postman_id": "5a524679-dd09-4ae4-aaaf-f9c8439015ad", "name": "Pipedrive API v1 Activities DealFields API", "description": "Activities are appointments/tasks/events on a calendar that can be associated with a deal, a lead, a person and an organization. Activities can be of different type (such as call, meeting, lunch or a custom type - see ActivityTypes object) and can be assigned to a particular user. Note that activities can also be created without a specific date/time.\n", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T02:37:10.000Z", "updatedAt": "2026-07-28T02:37:10.000Z", "lastUpdatedBy": "35240", "uid": "35240-5a524679-dd09-4ae4-aaaf-f9c8439015ad" }, "item": [ { "name": "dealFields", "item": [ { "name": "{id}", "item": [ { "name": "Get one deal field", "id": "0743fe66-62fa-4e1c-a6d7-f5ddf50806dd", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/dealFields/:id", "host": [ "{{baseUrl}}" ], "path": [ "dealFields", ":id" ], "variable": [ { "id": "eb657270-725c-4d30-b652-6ef219ce893c", "key": "id", "value": "", "description": "(Required) The ID of the field" } ] }, "description": "Returns data about a specific deal field." }, "response": [ { "id": "a4876004-4468-429e-a55c-e684433a922d", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/dealFields/:id", "host": [ "{{baseUrl}}" ], "path": [ "dealFields", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"data\": {\n \"id\": \"\",\n \"key\": \"\",\n \"name\": \"\",\n \"order_nr\": \"\",\n \"field_type\": \"phone\",\n \"add_time\": \"\",\n \"update_time\": \"\",\n \"last_updated_by_user_id\": \"\",\n \"created_by_user_id\": \"\",\n \"active_flag\": \"\",\n \"edit_flag\": \"\",\n \"index_visible_flag\": \"\",\n \"details_visible_flag\": \"\",\n \"add_visible_flag\": \"\",\n \"important_flag\": \"\",\n \"bulk_edit_allowed\": \"\",\n \"searchable_flag\": \"\",\n \"filtering_allowed\": \"\",\n \"sortable_flag\": \"\",\n \"mandatory_flag\": \"\",\n \"is_subfield\": \"\"\n }\n}", "createdAt": "2026-07-28T02:37:11.000Z", "updatedAt": "2026-07-28T02:37:11.000Z", "uid": "35240-a4876004-4468-429e-a55c-e684433a922d" } ], "createdAt": "2026-07-28T02:37:11.000Z", "updatedAt": "2026-07-28T02:37:11.000Z", "uid": "35240-0743fe66-62fa-4e1c-a6d7-f5ddf50806dd" }, { "name": "Delete a deal field", "id": "38840afb-91a5-4dc8-9eb8-15dc418eda4a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/dealFields/:id", "host": [ "{{baseUrl}}" ], "path": [ "dealFields", ":id" ], "variable": [ { "id": "0c8f1ba9-354f-42e5-911a-696e4750b880", "key": "id", "value": "", "description": "(Required) The ID of the field" } ] }, "description": "Marks a field as deleted. For more information, see the tutorial for deleting a custom field." }, "response": [ { "id": "10c0f34a-cdd3-46a3-9ecd-db8edaa9cb4a", "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/dealFields/:id", "host": [ "{{baseUrl}}" ], "path": [ "dealFields", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"data\": {\n \"id\": \"\"\n }\n}", "createdAt": "2026-07-28T02:37:11.000Z", "updatedAt": "2026-07-28T02:37:11.000Z", "uid": "35240-10c0f34a-cdd3-46a3-9ecd-db8edaa9cb4a" } ], "createdAt": "2026-07-28T02:37:11.000Z", "updatedAt": "2026-07-28T02:37:11.000Z", "uid": "35240-38840afb-91a5-4dc8-9eb8-15dc418eda4a" }, { "name": "Update a deal field", "id": "fbebc965-f14c-426f-b8c6-a4fc6010d290", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"add_visible_flag\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/dealFields/:id", "host": [ "{{baseUrl}}" ], "path": [ "dealFields", ":id" ], "variable": [ { "id": "15ae16af-baac-4b1c-9305-5a35d8e44ea8", "key": "id", "value": "", "description": "(Required) The ID of the field" } ] }, "description": "Updates a deal field. For more information, see the tutorial for updating custom fields' values." }, "response": [ { "id": "c8c05a81-3660-4ebb-a2d8-d9f072263712", "name": "Success", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-token", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"add_visible_flag\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/dealFields/:id", "host": [ "{{baseUrl}}" ], "path": [ "dealFields", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"data\": {\n \"id\": \"\",\n \"key\": \"\",\n \"name\": \"\",\n \"order_nr\": \"\",\n \"field_type\": \"phone\",\n \"add_time\": \"\",\n \"update_time\": \"\",\n \"last_updated_by_user_id\": \"\",\n \"created_by_user_id\": \"\",\n \"active_flag\": \"\",\n \"edit_flag\": \"\",\n \"index_visible_flag\": \"\",\n \"details_visible_flag\": \"\",\n \"add_visible_flag\": \"\",\n \"important_flag\": \"\",\n \"bulk_edit_allowed\": \"\",\n \"searchable_flag\": \"\",\n \"filtering_allowed\": \"\",\n \"sortable_flag\": \"\",\n \"mandatory_flag\": \"\",\n \"is_subfield\": \"\"\n }\n}", "createdAt": "2026-07-28T02:37:11.000Z", "updatedAt": "2026-07-28T02:37:11.000Z", "uid": "35240-c8c05a81-3660-4ebb-a2d8-d9f072263712" } ], "createdAt": "2026-07-28T02:37:11.000Z", "updatedAt": "2026-07-28T02:37:11.000Z", "uid": "35240-fbebc965-f14c-426f-b8c6-a4fc6010d290" } ], "id": "13bf7f64-6572-452f-a0c9-d33e92432b5f", "createdAt": "2026-07-28T02:37:11.000Z", "updatedAt": "2026-07-28T02:37:11.000Z", "uid": "35240-13bf7f64-6572-452f-a0c9-d33e92432b5f" }, { "name": "{field_code}", "item": [ { "name": "options", "item": [ { "name": "Add deal field options in bulk", "id": "1c5a8ee7-8420-49e3-a4b0-25d79498390b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"label\": \"\"\n },\n {\n \"label\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/dealFields/:field_code/options", "host": [ "{{baseUrl}}" ], "path": [ "dealFields", ":field_code", "options" ], "variable": [ { "id": "8fd3ef17-614a-4aa0-a0c4-d8bd068feda5", "key": "field_code", "value": "", "description": "(Required) The unique code identifying the field" } ] }, "description": "Adds new options to a deal custom field that supports options (enum or set field types). This operation is atomic - all options are added or none are added. Returns only the newly added options." }, "response": [ { "id": "26905179-f7c6-451d-a24b-5689edbc0457", "name": "Field options operation result", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-token", "value": "" } ], "body": { "mode": "raw", "raw": "[\n {\n \"label\": \"\"\n },\n {\n \"label\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/dealFields/:field_code/options", "host": [ "{{baseUrl}}" ], "path": [ "dealFields", ":field_code", "options" ], "variable": [ { "key": "field_code" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"data\": [\n {\n \"id\": \"\",\n \"label\": \"\"\n },\n {\n \"id\": \"\",\n \"label\": \"\"\n }\n ],\n \"additional_data\": {}\n}", "createdAt": "2026-07-28T02:37:11.000Z", "updatedAt": "2026-07-28T02:37:11.000Z", "uid": "35240-26905179-f7c6-451d-a24b-5689edbc0457" } ], "createdAt": "2026-07-28T02:37:11.000Z", "updatedAt": "2026-07-28T02:37:11.000Z", "uid": "35240-1c5a8ee7-8420-49e3-a4b0-25d79498390b" }, { "name": "Delete deal field options in bulk", "id": "2910c0fa-b167-414f-b05e-4c99b139b836", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/dealFields/:field_code/options", "host": [ "{{baseUrl}}" ], "path": [ "dealFields", ":field_code", "options" ], "variable": [ { "id": "0ec78120-3b95-4f71-9312-111924da2f81", "key": "field_code", "value": "", "description": "(Required) The unique code identifying the field" } ] }, "description": "Removes existing options from a deal custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the deleted options." }, "response": [ { "id": "07517679-acbb-4f08-a250-562d6450ad56", "name": "Field options operation result", "originalRequest": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-token", "value": "" } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/dealFields/:field_code/options", "host": [ "{{baseUrl}}" ], "path": [ "dealFields", ":field_code", "options" ], "variable": [ { "key": "field_code" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"data\": [\n {\n \"id\": \"\",\n \"label\": \"\"\n },\n {\n \"id\": \"\",\n \"label\": \"\"\n }\n ],\n \"additional_data\": {}\n}", "createdAt": "2026-07-28T02:37:11.000Z", "updatedAt": "2026-07-28T02:37:11.000Z", "uid": "35240-07517679-acbb-4f08-a250-562d6450ad56" } ], "createdAt": "2026-07-28T02:37:11.000Z", "updatedAt": "2026-07-28T02:37:11.000Z", "uid": "35240-2910c0fa-b167-414f-b05e-4c99b139b836" }, { "name": "Update deal field options in bulk", "id": "9dbf06ed-5c17-424e-91c1-034cd1586d0a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": \"\",\n \"label\": \"\"\n },\n {\n \"id\": \"\",\n \"label\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/dealFields/:field_code/options", "host": [ "{{baseUrl}}" ], "path": [ "dealFields", ":field_code", "options" ], "variable": [ { "id": "bc04a2d3-56e1-4a61-ab9e-984c2fc64bfd", "key": "field_code", "value": "", "description": "(Required) The unique code identifying the field" } ] }, "description": "Updates existing options for a deal custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the updated options." }, "response": [ { "id": "682a1cc7-7c30-4f16-81b1-2be56663da3c", "name": "Field options operation result", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-token", "value": "" } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": \"\",\n \"label\": \"\"\n },\n {\n \"id\": \"\",\n \"label\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/dealFields/:field_code/options", "host": [ "{{baseUrl}}" ], "path": [ "dealFields", ":field_code", "options" ], "variable": [ { "key": "field_code" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"data\": [\n {\n \"id\": \"\",\n \"label\": \"\"\n },\n {\n \"id\": \"\",\n \"label\": \"\"\n }\n ],\n \"additional_data\": {}\n}", "createdAt": "2026-07-28T02:37:11.000Z", "updatedAt": "2026-07-28T02:37:11.000Z", "uid": "35240-682a1cc7-7c30-4f16-81b1-2be56663da3c" } ], "createdAt": "2026-07-28T02:37:11.000Z", "updatedAt": "2026-07-28T02:37:11.000Z", "uid": "35240-9dbf06ed-5c17-424e-91c1-034cd1586d0a" } ], "id": "91a50132-9362-4c54-8afe-084700c8fba5", "createdAt": "2026-07-28T02:37:11.000Z", "updatedAt": "2026-07-28T02:37:11.000Z", "uid": "35240-91a50132-9362-4c54-8afe-084700c8fba5" }, { "name": "Get one deal field", "id": "a852b49e-75d8-4342-8949-2c60e34d5885", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/dealFields/:field_code?include_fields=ui_visibility,important_fields,required_fields", "host": [ "{{baseUrl}}" ], "path": [ "dealFields", ":field_code" ], "query": [ { "description": "Optional comma separated string array of additional data namespaces to include in response", "key": "include_fields", "value": "ui_visibility,important_fields,required_fields" } ], "variable": [ { "id": "bcdfe1ed-a551-4caf-9696-c904a6e2287f", "key": "field_code", "value": "", "description": "(Required) The unique code identifying the field" } ] }, "description": "Returns metadata about a specific deal field." }, "response": [ { "id": "278c6450-e54d-40ab-8527-4b67cb797f79", "name": "Get one deal field", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/dealFields/:field_code?include_fields=ui_visibility,important_fields,required_fields", "host": [ "{{baseUrl}}" ], "path": [ "dealFields", ":field_code" ], "query": [ { "description": "Optional comma separated string array of additional data namespaces to include in response", "key": "include_fields", "value": "ui_visibility,important_fields,required_fields" } ], "variable": [ { "key": "field_code" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"data\": {\n \"field_name\": \"\",\n \"field_code\": \"\",\n \"description\": \"\",\n \"field_type\": \"user\",\n \"is_custom_field\": \"\",\n \"is_optional_response_field\": \"\",\n \"options\": [\n {\n \"id\": \"\",\n \"label\": \"\",\n \"color\": \"\",\n \"update_time\": \"\",\n \"add_time\": \"\"\n },\n {\n \"id\": \"\",\n \"label\": \"\",\n \"color\": \"\",\n \"update_time\": \"\",\n \"add_time\": \"\"\n }\n ],\n \"subfields\": [\n {\n \"field_code\": \"\",\n \"field_name\": \"\",\n \"field_type\": \"\"\n },\n {\n \"field_code\": \"\",\n \"field_name\": \"\",\n \"field_type\": \"\"\n }\n ],\n \"ui_visibility\": {\n \"add_visible_flag\": \"\",\n \"details_visible_flag\": \"\",\n \"projects_detail_visible_flag\": \"\",\n \"show_in_pipelines\": {\n \"show_in_all\": \"\",\n \"pipeline_ids\": [\n \"\",\n \"\"\n ]\n }\n },\n \"important_fields\": {\n \"enabled\": \"\",\n \"stage_ids\": [\n \"\",\n \"\"\n ]\n },\n \"required_fields\": {\n \"enabled\": \"\",\n \"stage_ids\": [\n \"\",\n \"\"\n ],\n \"statuses\": {\n \"magna6\": [\n \"won\",\n \"lost\"\n ]\n }\n }\n }\n}", "createdAt": "2026-07-28T02:37:11.000Z", "updatedAt": "2026-07-28T02:37:11.000Z", "uid": "35240-278c6450-e54d-40ab-8527-4b67cb797f79" } ], "createdAt": "2026-07-28T02:37:11.000Z", "updatedAt": "2026-07-28T02:37:11.000Z", "uid": "35240-a852b49e-75d8-4342-8949-2c60e34d5885" }, { "name": "Update one deal field", "id": "bc84c8a8-c1c8-4e91-afe1-975c4825bd5a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"field_name\": \"\",\n \"ui_visibility\": {\n \"add_visible_flag\": false,\n \"details_visible_flag\": true,\n \"projects_detail_visible_flag\": false,\n \"show_in_pipelines\": {\n \"show_in_all\": true,\n \"pipeline_ids\": [\n \"\",\n \"\"\n ]\n }\n },\n \"important_fields\": {\n \"enabled\": false\n },\n \"required_fields\": {\n \"enabled\": false,\n \"statuses\": {}\n },\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/dealFields/:field_code", "host": [ "{{baseUrl}}" ], "path": [ "dealFields", ":field_code" ], "variable": [ { "id": "e41748a0-a89a-4e48-beb5-b281d6311088", "key": "field_code", "value": "", "description": "(Required) The unique code identifying the field" } ] }, "description": "Updates a deal custom field. The field_code and field_type cannot be changed. At least one field must be provided in the request body." }, "response": [ { "id": "8c7a4cff-f328-441f-a133-ed06a3bfc1a0", "name": "Get one deal field", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-token", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"field_name\": \"\",\n \"ui_visibility\": {\n \"add_visible_flag\": false,\n \"details_visible_flag\": true,\n \"projects_detail_visible_flag\": false,\n \"show_in_pipelines\": {\n \"show_in_all\": true,\n \"pipeline_ids\": [\n \"\",\n \"\"\n ]\n }\n },\n \"important_fields\": {\n \"enabled\": false\n },\n \"required_fields\": {\n \"enabled\": false,\n \"statuses\": {}\n },\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/dealFields/:field_code", "host": [ "{{baseUrl}}" ], "path": [ "dealFields", ":field_code" ], "variable": [ { "key": "field_code" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"data\": {\n \"field_name\": \"\",\n \"field_code\": \"\",\n \"description\": \"\",\n \"field_type\": \"user\",\n \"is_custom_field\": \"\",\n \"is_optional_response_field\": \"\",\n \"options\": [\n {\n \"id\": \"\",\n \"label\": \"\",\n \"color\": \"\",\n \"update_time\": \"\",\n \"add_time\": \"\"\n },\n {\n \"id\": \"\",\n \"label\": \"\",\n \"color\": \"\",\n \"update_time\": \"\",\n \"add_time\": \"\"\n }\n ],\n \"subfields\": [\n {\n \"field_code\": \"\",\n \"field_name\": \"\",\n \"field_type\": \"\"\n },\n {\n \"field_code\": \"\",\n \"field_name\": \"\",\n \"field_type\": \"\"\n }\n ],\n \"ui_visibility\": {\n \"add_visible_flag\": \"\",\n \"details_visible_flag\": \"\",\n \"projects_detail_visible_flag\": \"\",\n \"show_in_pipelines\": {\n \"show_in_all\": \"\",\n \"pipeline_ids\": [\n \"\",\n \"\"\n ]\n }\n },\n \"important_fields\": {\n \"enabled\": \"\",\n \"stage_ids\": [\n \"\",\n \"\"\n ]\n },\n \"required_fields\": {\n \"enabled\": \"\",\n \"stage_ids\": [\n \"\",\n \"\"\n ],\n \"statuses\": {\n \"magna6\": [\n \"won\",\n \"lost\"\n ]\n }\n }\n }\n}", "createdAt": "2026-07-28T02:37:11.000Z", "updatedAt": "2026-07-28T02:37:11.000Z", "uid": "35240-8c7a4cff-f328-441f-a133-ed06a3bfc1a0" } ], "createdAt": "2026-07-28T02:37:11.000Z", "updatedAt": "2026-07-28T02:37:11.000Z", "uid": "35240-bc84c8a8-c1c8-4e91-afe1-975c4825bd5a" }, { "name": "Delete one deal field", "id": "05593040-f6cf-4c92-9a65-d5ad54245670", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/dealFields/:field_code", "host": [ "{{baseUrl}}" ], "path": [ "dealFields", ":field_code" ], "variable": [ { "id": "2a2d896b-eebb-4c0a-b428-d4331137bc9b", "key": "field_code", "value": "", "description": "(Required) The unique code identifying the field" } ] }, "description": "Marks a custom field as deleted." }, "response": [ { "id": "e2782237-0109-4753-b9c3-d3b0a98d89b2", "name": "Delete one deal field", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/dealFields/:field_code", "host": [ "{{baseUrl}}" ], "path": [ "dealFields", ":field_code" ], "variable": [ { "key": "field_code" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"data\": {\n \"field_name\": \"\",\n \"field_code\": \"\",\n \"description\": \"\",\n \"field_type\": \"\",\n \"is_custom_field\": \"\",\n \"is_optional_response_field\": \"\"\n }\n}", "createdAt": "2026-07-28T02:37:11.000Z", "updatedAt": "2026-07-28T02:37:11.000Z", "uid": "35240-e2782237-0109-4753-b9c3-d3b0a98d89b2" } ], "createdAt": "2026-07-28T02:37:11.000Z", "updatedAt": "2026-07-28T02:37:11.000Z", "uid": "35240-05593040-f6cf-4c92-9a65-d5ad54245670" } ], "id": "5a5467d3-2e69-4bf1-95aa-f693095c836a", "createdAt": "2026-07-28T02:37:11.000Z", "updatedAt": "2026-07-28T02:37:11.000Z", "uid": "35240-5a5467d3-2e69-4bf1-95aa-f693095c836a" }, { "name": "Get all deal fields", "id": "843bc9b6-b9e9-4e95-ba91-258a4deea97d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/dealFields?start=0&limit=", "host": [ "{{baseUrl}}" ], "path": [ "dealFields" ], "query": [ { "description": "Pagination start", "key": "start", "value": "0" }, { "description": "Items shown per page", "key": "limit", "value": "" } ] }, "description": "Returns data about all deal fields." }, "response": [ { "id": "1ddc7710-3b1e-4d33-99fb-efcf3c60099c", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/dealFields?start=0&limit=", "host": [ "{{baseUrl}}" ], "path": [ "dealFields" ], "query": [ { "description": "Pagination start", "key": "start", "value": "0" }, { "description": "Items shown per page", "key": "limit", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"data\": [\n {\n \"id\": \"\",\n \"key\": \"\",\n \"name\": \"\",\n \"order_nr\": \"\",\n \"field_type\": \"text\",\n \"add_time\": \"\",\n \"update_time\": \"\",\n \"last_updated_by_user_id\": \"\",\n \"created_by_user_id\": \"\",\n \"active_flag\": \"\",\n \"edit_flag\": \"\",\n \"index_visible_flag\": \"\",\n \"details_visible_flag\": \"\",\n \"add_visible_flag\": \"\",\n \"important_flag\": \"\",\n \"bulk_edit_allowed\": \"\",\n \"searchable_flag\": \"\",\n \"filtering_allowed\": \"\",\n \"sortable_flag\": \"\",\n \"mandatory_flag\": \"\",\n \"is_subfield\": \"\"\n },\n {\n \"id\": \"\",\n \"key\": \"\",\n \"name\": \"\",\n \"order_nr\": \"\",\n \"field_type\": \"visible_to\",\n \"add_time\": \"\",\n \"update_time\": \"\",\n \"last_updated_by_user_id\": \"\",\n \"created_by_user_id\": \"\",\n \"active_flag\": \"\",\n \"edit_flag\": \"\",\n \"index_visible_flag\": \"\",\n \"details_visible_flag\": \"\",\n \"add_visible_flag\": \"\",\n \"important_flag\": \"\",\n \"bulk_edit_allowed\": \"\",\n \"searchable_flag\": \"\",\n \"filtering_allowed\": \"\",\n \"sortable_flag\": \"\",\n \"mandatory_flag\": \"\",\n \"is_subfield\": \"\"\n }\n ],\n \"additional_data\": {\n \"start\": \"\",\n \"limit\": \"\",\n \"more_items_in_collection\": \"\"\n }\n}", "createdAt": "2026-07-28T02:37:11.000Z", "updatedAt": "2026-07-28T02:37:11.000Z", "uid": "35240-1ddc7710-3b1e-4d33-99fb-efcf3c60099c" } ], "createdAt": "2026-07-28T02:37:11.000Z", "updatedAt": "2026-07-28T02:37:11.000Z", "uid": "35240-843bc9b6-b9e9-4e95-ba91-258a4deea97d" }, { "name": "Add a new deal field", "id": "c456d373-cbe2-446d-a4fa-ba257f4b5c3c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"field_type\": \"user\",\n \"name\": \"\",\n \"add_visible_flag\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/dealFields", "host": [ "{{baseUrl}}" ], "path": [ "dealFields" ] }, "description": "Adds a new deal field. For more information, see the tutorial for adding a new custom field." }, "response": [ { "id": "3a3fed5f-a928-4096-944d-70aa281b0932", "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-token", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"field_type\": \"user\",\n \"name\": \"\",\n \"add_visible_flag\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/dealFields", "host": [ "{{baseUrl}}" ], "path": [ "dealFields" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"data\": {\n \"id\": \"\",\n \"key\": \"\",\n \"name\": \"\",\n \"order_nr\": \"\",\n \"field_type\": \"phone\",\n \"add_time\": \"\",\n \"update_time\": \"\",\n \"last_updated_by_user_id\": \"\",\n \"created_by_user_id\": \"\",\n \"active_flag\": \"\",\n \"edit_flag\": \"\",\n \"index_visible_flag\": \"\",\n \"details_visible_flag\": \"\",\n \"add_visible_flag\": \"\",\n \"important_flag\": \"\",\n \"bulk_edit_allowed\": \"\",\n \"searchable_flag\": \"\",\n \"filtering_allowed\": \"\",\n \"sortable_flag\": \"\",\n \"mandatory_flag\": \"\",\n \"is_subfield\": \"\"\n }\n}", "createdAt": "2026-07-28T02:37:11.000Z", "updatedAt": "2026-07-28T02:37:11.000Z", "uid": "35240-3a3fed5f-a928-4096-944d-70aa281b0932" } ], "createdAt": "2026-07-28T02:37:11.000Z", "updatedAt": "2026-07-28T02:37:11.000Z", "uid": "35240-c456d373-cbe2-446d-a4fa-ba257f4b5c3c" }, { "name": "Delete multiple deal fields in bulk", "id": "5cda4603-479f-45ee-8931-4db2ec343e50", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/dealFields?ids=", "host": [ "{{baseUrl}}" ], "path": [ "dealFields" ], "query": [ { "description": "(Required) The comma-separated field IDs to delete", "key": "ids", "value": "" } ] }, "description": "Marks multiple deal fields as deleted." }, "response": [ { "id": "88485622-8349-4e87-a7eb-e57d52427763", "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-token", "value": "" } ], "url": { "raw": "{{baseUrl}}/dealFields?ids=", "host": [ "{{baseUrl}}" ], "path": [ "dealFields" ], "query": [ { "description": "(Required) The comma-separated field IDs to delete", "key": "ids", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"data\": {\n \"id\": [\n \"\",\n \"\"\n ]\n }\n}", "createdAt": "2026-07-28T02:37:11.000Z", "updatedAt": "2026-07-28T02:37:11.000Z", "uid": "35240-88485622-8349-4e87-a7eb-e57d52427763" } ], "createdAt": "2026-07-28T02:37:11.000Z", "updatedAt": "2026-07-28T02:37:11.000Z", "uid": "35240-5cda4603-479f-45ee-8931-4db2ec343e50" } ], "id": "5719607e-ed4b-4010-99d1-fe189e9f0c45", "createdAt": "2026-07-28T02:37:11.000Z", "updatedAt": "2026-07-28T02:37:11.000Z", "uid": "35240-5719607e-ed4b-4010-99d1-fe189e9f0c45" } ], "variable": [ { "key": "baseUrl", "value": "https://api.pipedrive.com/v1" } ] }