{
"opencollection": "1.0.0",
"info": {
"name": "Pipedrive API v1 Activities ProductFields API",
"version": "1.0.0"
},
"items": [
{
"info": {
"name": "ProductFields",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get all product fields",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.pipedrive.com/v1/productFields",
"params": [
{
"name": "start",
"value": "",
"type": "query",
"description": "Pagination start"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Items shown per page"
}
],
"auth": {
"type": "apikey",
"key": "x-api-token",
"value": "{{x-api-token}}",
"placement": "header"
}
},
"docs": "Returns data about all product fields."
},
{
"info": {
"name": "Add a new product field",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.pipedrive.com/v1/productFields",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "x-api-token",
"value": "{{x-api-token}}",
"placement": "header"
}
},
"docs": "Adds a new product field. For more information, see the tutorial for adding a new custom field."
},
{
"info": {
"name": "Delete multiple product fields in bulk",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.pipedrive.com/v1/productFields",
"params": [
{
"name": "ids",
"value": "",
"type": "query",
"description": "The comma-separated field IDs to delete"
}
],
"auth": {
"type": "apikey",
"key": "x-api-token",
"value": "{{x-api-token}}",
"placement": "header"
}
},
"docs": "Marks multiple fields as deleted."
},
{
"info": {
"name": "Get one product field",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.pipedrive.com/v1/productFields/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the product field"
}
],
"auth": {
"type": "apikey",
"key": "x-api-token",
"value": "{{x-api-token}}",
"placement": "header"
}
},
"docs": "Returns data about a specific product field."
},
{
"info": {
"name": "Update a product field",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.pipedrive.com/v1/productFields/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the product field"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "x-api-token",
"value": "{{x-api-token}}",
"placement": "header"
}
},
"docs": "Updates a product field. For more information, see the tutorial for updating custom fields' values."
},
{
"info": {
"name": "Delete a product field",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.pipedrive.com/v1/productFields/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the product field"
}
],
"auth": {
"type": "apikey",
"key": "x-api-token",
"value": "{{x-api-token}}",
"placement": "header"
}
},
"docs": "Marks a product field as deleted. For more information, see the tutorial for deleting a custom field."
},
{
"info": {
"name": "Get one product field",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.pipedrive.com/v1/productFields/:field_code",
"params": [
{
"name": "field_code",
"value": "",
"type": "path",
"description": "The unique code identifying the field"
},
{
"name": "include_fields",
"value": "",
"type": "query",
"description": "Optional comma separated string array of additional data namespaces to include in response"
}
],
"auth": {
"type": "apikey",
"key": "x-api-token",
"value": "{{x-api-token}}",
"placement": "header"
}
},
"docs": "Returns metadata about a specific product field."
},
{
"info": {
"name": "Update one product field",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.pipedrive.com/v1/productFields/:field_code",
"params": [
{
"name": "field_code",
"value": "",
"type": "path",
"description": "The unique code identifying the field"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "x-api-token",
"value": "{{x-api-token}}",
"placement": "header"
}
},
"docs": "Updates a product custom field. The field_code and field_type cannot be changed. At least one field must be provided in the request body."
},
{
"info": {
"name": "Delete one product field",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.pipedrive.com/v1/productFields/:field_code",
"params": [
{
"name": "field_code",
"value": "",
"type": "path",
"description": "The unique code identifying the field"
}
],
"auth": {
"type": "apikey",
"key": "x-api-token",
"value": "{{x-api-token}}",
"placement": "header"
}
},
"docs": "Marks a custom field as deleted."
},
{
"info": {
"name": "Add product field options in bulk",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.pipedrive.com/v1/productFields/:field_code/options",
"params": [
{
"name": "field_code",
"value": "",
"type": "path",
"description": "The unique code identifying the field"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "x-api-token",
"value": "{{x-api-token}}",
"placement": "header"
}
},
"docs": "Adds new options to a product 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."
},
{
"info": {
"name": "Update product field options in bulk",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.pipedrive.com/v1/productFields/:field_code/options",
"params": [
{
"name": "field_code",
"value": "",
"type": "path",
"description": "The unique code identifying the field"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "x-api-token",
"value": "{{x-api-token}}",
"placement": "header"
}
},
"docs": "Updates existing options for a product custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the updated options."
},
{
"info": {
"name": "Delete product field options in bulk",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.pipedrive.com/v1/productFields/:field_code/options",
"params": [
{
"name": "field_code",
"value": "",
"type": "path",
"description": "The unique code identifying the field"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "x-api-token",
"value": "{{x-api-token}}",
"placement": "header"
}
},
"docs": "Removes existing options from a product custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the deleted options."
}
]
}
],
"bundled": true
}