{
  "opencollection": "1.0.0",
  "info": {
    "name": "Pipedrive API v1 Activities PersonFields API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "PersonFields",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get all person fields",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.pipedrive.com/v1/personFields",
            "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 person fields.<br>If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field."
        },
        {
          "info": {
            "name": "Add a new person field",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.pipedrive.com/v1/personFields",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "x-api-token",
              "value": "{{x-api-token}}",
              "placement": "header"
            }
          },
          "docs": "Adds a new person field. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-a-new-custom-field\" target=\"_blank\" rel=\"noopener noreferrer\">adding a new custom field</a>."
        },
        {
          "info": {
            "name": "Delete multiple person fields in bulk",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.pipedrive.com/v1/personFields",
            "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 person field",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.pipedrive.com/v1/personFields/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the field"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "x-api-token",
              "value": "{{x-api-token}}",
              "placement": "header"
            }
          },
          "docs": "Returns data about a specific person field."
        },
        {
          "info": {
            "name": "Update a person field",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.pipedrive.com/v1/personFields/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the field"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "x-api-token",
              "value": "{{x-api-token}}",
              "placement": "header"
            }
          },
          "docs": "Updates a person field. For more information, see the tutorial for <a href=\" https://pipedrive.readme.io/docs/updating-custom-field-value \" target=\"_blank\" rel=\"noopener noreferrer\">updating custom fields' values</a>."
        },
        {
          "info": {
            "name": "Delete a person field",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.pipedrive.com/v1/personFields/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the field"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "x-api-token",
              "value": "{{x-api-token}}",
              "placement": "header"
            }
          },
          "docs": "Marks a field as deleted. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/deleting-a-custom-field\" target=\"_blank\" rel=\"noopener noreferrer\">deleting a custom field</a>."
        },
        {
          "info": {
            "name": "Get one person field",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.pipedrive.com/v1/personFields/: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 person field."
        },
        {
          "info": {
            "name": "Update one person field",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.pipedrive.com/v1/personFields/: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 person 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 person field",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.pipedrive.com/v1/personFields/: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 person field options in bulk",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.pipedrive.com/v1/personFields/: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 person 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 person field options in bulk",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.pipedrive.com/v1/personFields/: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 person 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 person field options in bulk",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.pipedrive.com/v1/personFields/: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 person 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
}