Pipedrive\versions\v2\ProductFieldsApi

All URIs are relative to https://api.pipedrive.com/api/v2.

Method	HTTP request	Description
addProductField()	POST /productFields	Create one product field
addProductFieldOptions()	POST /productFields/{field_code}/options	Add product field options in bulk
deleteProductField()	DELETE /productFields/{field_code}	Delete one product field
deleteProductFieldOptions()	DELETE /productFields/{field_code}/options	Delete product field options in bulk
getProductField()	GET /productFields/{field_code}	Get one product field
getProductFields()	GET /productFields	Get all product fields
updateProductField()	PATCH /productFields/{field_code}	Update one product field
updateProductFieldOptions()	PATCH /productFields/{field_code}/options	Update product field options in bulk

`addProductField()`

addProductField($create_product_field_request): \Pipedrive\versions\v2\Model\CreateProductField

Create one product field

Creates a new product custom field.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: api_key
$config = (new Pipedrive\versions\v2\Configuration())->setApiKey('x-api-token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = (new Pipedrive\versions\v2\Configuration())->setApiKeyPrefix('x-api-token', 'Bearer');

// Configure OAuth2 access token for authorization: oauth2
$config = (new Pipedrive\versions\v2\Configuration())->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Pipedrive\versions\v2\Api\ProductFieldsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$create_product_field_request = new \Pipedrive\versions\v2\Model\CreateProductFieldRequest(); // \Pipedrive\versions\v2\Model\CreateProductFieldRequest

try {
    $result = $apiInstance->addProductField($create_product_field_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductFieldsApi->addProductField: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
create_product_field_request	\Pipedrive\versions\v2\Model\CreateProductFieldRequest

Return type

\Pipedrive\versions\v2\Model\CreateProductField

Authorization

api_key, oauth2

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`addProductFieldOptions()`

addProductFieldOptions($field_code, $request_body): \Pipedrive\versions\v2\Model\InlineResponse200

Add product field options in bulk

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.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: api_key
$config = (new Pipedrive\versions\v2\Configuration())->setApiKey('x-api-token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = (new Pipedrive\versions\v2\Configuration())->setApiKeyPrefix('x-api-token', 'Bearer');

// Configure OAuth2 access token for authorization: oauth2
$config = (new Pipedrive\versions\v2\Configuration())->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Pipedrive\versions\v2\Api\ProductFieldsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$field_code = 'field_code_example'; // string | The unique code identifying the field
$request_body = array(new \stdClass); // object[]

try {
    $result = $apiInstance->addProductFieldOptions($field_code, $request_body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductFieldsApi->addProductFieldOptions: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
field_code	string	The unique code identifying the field
request_body	object[]

Return type

\Pipedrive\versions\v2\Model\InlineResponse200

Authorization

api_key, oauth2

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`deleteProductField()`

deleteProductField($field_code): \Pipedrive\versions\v2\Model\DeleteProductField

Delete one product field

Marks a custom field as deleted.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: api_key
$config = (new Pipedrive\versions\v2\Configuration())->setApiKey('x-api-token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = (new Pipedrive\versions\v2\Configuration())->setApiKeyPrefix('x-api-token', 'Bearer');

// Configure OAuth2 access token for authorization: oauth2
$config = (new Pipedrive\versions\v2\Configuration())->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Pipedrive\versions\v2\Api\ProductFieldsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$field_code = 'field_code_example'; // string | The unique code identifying the field

try {
    $result = $apiInstance->deleteProductField($field_code);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductFieldsApi->deleteProductField: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
field_code	string	The unique code identifying the field

Return type

\Pipedrive\versions\v2\Model\DeleteProductField

Authorization

api_key, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`deleteProductFieldOptions()`

deleteProductFieldOptions($field_code, $request_body): \Pipedrive\versions\v2\Model\InlineResponse200

Delete product field options in bulk

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.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: api_key
$config = (new Pipedrive\versions\v2\Configuration())->setApiKey('x-api-token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = (new Pipedrive\versions\v2\Configuration())->setApiKeyPrefix('x-api-token', 'Bearer');

// Configure OAuth2 access token for authorization: oauth2
$config = (new Pipedrive\versions\v2\Configuration())->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Pipedrive\versions\v2\Api\ProductFieldsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$field_code = 'field_code_example'; // string | The unique code identifying the field
$request_body = array(new \stdClass); // object[]

try {
    $result = $apiInstance->deleteProductFieldOptions($field_code, $request_body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductFieldsApi->deleteProductFieldOptions: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
field_code	string	The unique code identifying the field
request_body	object[]

Return type

\Pipedrive\versions\v2\Model\InlineResponse200

Authorization

api_key, oauth2

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getProductField()`

getProductField($field_code, $include_fields): \Pipedrive\versions\v2\Model\GetProductField

Get one product field

Returns metadata about a specific product field.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: api_key
$config = (new Pipedrive\versions\v2\Configuration())->setApiKey('x-api-token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = (new Pipedrive\versions\v2\Configuration())->setApiKeyPrefix('x-api-token', 'Bearer');

// Configure OAuth2 access token for authorization: oauth2
$config = (new Pipedrive\versions\v2\Configuration())->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Pipedrive\versions\v2\Api\ProductFieldsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$field_code = 'field_code_example'; // string | The unique code identifying the field
$include_fields = 'include_fields_example'; // string | Optional comma separated string array of additional data namespaces to include in response

try {
    $result = $apiInstance->getProductField($field_code, $include_fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductFieldsApi->getProductField: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
field_code	string	The unique code identifying the field
include_fields	string	Optional comma separated string array of additional data namespaces to include in response	[optional]

Return type

\Pipedrive\versions\v2\Model\GetProductField

Authorization

api_key, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getProductFields()`

getProductFields($include_fields, $limit, $cursor): \Pipedrive\versions\v2\Model\GetProductFields

Get all product fields

Returns metadata about all product fields in the company.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: api_key
$config = (new Pipedrive\versions\v2\Configuration())->setApiKey('x-api-token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = (new Pipedrive\versions\v2\Configuration())->setApiKeyPrefix('x-api-token', 'Bearer');

// Configure OAuth2 access token for authorization: oauth2
$config = (new Pipedrive\versions\v2\Configuration())->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Pipedrive\versions\v2\Api\ProductFieldsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$include_fields = 'include_fields_example'; // string | Optional comma separated string array of additional data namespaces to include in response
$limit = 100; // int | For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
$cursor = 'cursor_example'; // string | For pagination, the marker (an opaque string value) representing the first item on the next page

try {
    $result = $apiInstance->getProductFields($include_fields, $limit, $cursor);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductFieldsApi->getProductFields: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
include_fields	string	Optional comma separated string array of additional data namespaces to include in response	[optional]
limit	int	For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.	[optional]
cursor	string	For pagination, the marker (an opaque string value) representing the first item on the next page	[optional]

Return type

\Pipedrive\versions\v2\Model\GetProductFields

Authorization

api_key, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`updateProductField()`

updateProductField($field_code, $update_product_field_request): \Pipedrive\versions\v2\Model\GetProductField

Update one product field

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.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: api_key
$config = (new Pipedrive\versions\v2\Configuration())->setApiKey('x-api-token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = (new Pipedrive\versions\v2\Configuration())->setApiKeyPrefix('x-api-token', 'Bearer');

// Configure OAuth2 access token for authorization: oauth2
$config = (new Pipedrive\versions\v2\Configuration())->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Pipedrive\versions\v2\Api\ProductFieldsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$field_code = 'field_code_example'; // string | The unique code identifying the field
$update_product_field_request = new \Pipedrive\versions\v2\Model\UpdateProductFieldRequest(); // \Pipedrive\versions\v2\Model\UpdateProductFieldRequest

try {
    $result = $apiInstance->updateProductField($field_code, $update_product_field_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductFieldsApi->updateProductField: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
field_code	string	The unique code identifying the field
update_product_field_request	\Pipedrive\versions\v2\Model\UpdateProductFieldRequest

Return type

\Pipedrive\versions\v2\Model\GetProductField

Authorization

api_key, oauth2

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`updateProductFieldOptions()`

updateProductFieldOptions($field_code, $request_body): \Pipedrive\versions\v2\Model\InlineResponse200

Update product field options in bulk

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.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: api_key
$config = (new Pipedrive\versions\v2\Configuration())->setApiKey('x-api-token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = (new Pipedrive\versions\v2\Configuration())->setApiKeyPrefix('x-api-token', 'Bearer');

// Configure OAuth2 access token for authorization: oauth2
$config = (new Pipedrive\versions\v2\Configuration())->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Pipedrive\versions\v2\Api\ProductFieldsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$field_code = 'field_code_example'; // string | The unique code identifying the field
$request_body = array(new \stdClass); // object[]

try {
    $result = $apiInstance->updateProductFieldOptions($field_code, $request_body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductFieldsApi->updateProductFieldOptions: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
field_code	string	The unique code identifying the field
request_body	object[]

Return type

\Pipedrive\versions\v2\Model\InlineResponse200

Authorization

api_key, oauth2

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Uh oh!

FilesExpand file tree

ProductFieldsApi.md

Latest commit

History

ProductFieldsApi.md

File metadata and controls

Pipedrive\versions\v2\ProductFieldsApi

addProductField()

Example

Parameters

Return type

Authorization

HTTP request headers

addProductFieldOptions()

Example

Parameters

Return type

Authorization

HTTP request headers

deleteProductField()

Example

Parameters

Return type

Authorization

HTTP request headers

deleteProductFieldOptions()

Example

Parameters

Return type

Authorization

HTTP request headers

getProductField()

Example

Parameters

Return type

Authorization

HTTP request headers

getProductFields()

Example

Parameters

Return type

Authorization

HTTP request headers

updateProductField()

Example

Parameters

Return type

Authorization

HTTP request headers

updateProductFieldOptions()

Example

Parameters

Return type

Authorization

HTTP request headers

`addProductField()`

`addProductFieldOptions()`

`deleteProductField()`

`deleteProductFieldOptions()`

`getProductField()`

`getProductFields()`

`updateProductField()`

`updateProductFieldOptions()`