Itsmind\Sevdesk\ContactFieldApi

All URIs are relative to https://my.sevdesk.de/api/v1, except if the operation defines another base path.

Method	HTTP request	Description
createContactField()	POST /ContactCustomField	Create contact field
createContactFieldSetting()	POST /ContactCustomFieldSetting	Create contact field setting
deleteContactCustomFieldId()	DELETE /ContactCustomField/{contactCustomFieldId}	delete a contact field
deleteContactFieldSetting()	DELETE /ContactCustomFieldSetting/{contactCustomFieldSettingId}	Deletes a contact field setting
getContactFieldSettingById()	GET /ContactCustomFieldSetting/{contactCustomFieldSettingId}	Find contact field setting by ID
getContactFieldSettings()	GET /ContactCustomFieldSetting	Retrieve contact field settings
getContactFields()	GET /ContactCustomField	Retrieve contact fields
getContactFieldsById()	GET /ContactCustomField/{contactCustomFieldId}	Retrieve contact fields
getPlaceholder()	GET /Textparser/fetchDictionaryEntriesByType	Retrieve Placeholders
getReferenceCount()	GET /ContactCustomFieldSetting/{contactCustomFieldSettingId}/getReferenceCount	Receive count reference
updateContactFieldSetting()	PUT /ContactCustomFieldSetting/{contactCustomFieldSettingId}	Update contact field setting
updateContactfield()	PUT /ContactCustomField/{contactCustomFieldId}	Update a contact field

`createContactField()`

createContactField($model_contact_custom_field): \Itsmind\Sevdesk\Model\ModelContactCustomFieldResponse

Create contact field

Example

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


// Configure API key authorization: api_key
$config = Itsmind\Sevdesk\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Itsmind\Sevdesk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new Itsmind\Sevdesk\Api\ContactFieldApi(
    // 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
);
$model_contact_custom_field = new \Itsmind\Sevdesk\Model\ModelContactCustomField(); // \Itsmind\Sevdesk\Model\ModelContactCustomField

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

Parameters

Name	Type	Description	Notes
model_contact_custom_field	\Itsmind\Sevdesk\Model\ModelContactCustomField		[optional]

Return type

\Itsmind\Sevdesk\Model\ModelContactCustomFieldResponse

Authorization

api_key

HTTP request headers

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

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

`createContactFieldSetting()`

createContactFieldSetting($model_contact_custom_field_setting): \Itsmind\Sevdesk\Model\CreateContactFieldSetting200Response

Create contact field setting

Example

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


// Configure API key authorization: api_key
$config = Itsmind\Sevdesk\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Itsmind\Sevdesk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new Itsmind\Sevdesk\Api\ContactFieldApi(
    // 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
);
$model_contact_custom_field_setting = new \Itsmind\Sevdesk\Model\ModelContactCustomFieldSetting(); // \Itsmind\Sevdesk\Model\ModelContactCustomFieldSetting

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

Parameters

Name	Type	Description	Notes
model_contact_custom_field_setting	\Itsmind\Sevdesk\Model\ModelContactCustomFieldSetting		[optional]

Return type

\Itsmind\Sevdesk\Model\CreateContactFieldSetting200Response

Authorization

api_key

HTTP request headers

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

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

`deleteContactCustomFieldId()`

deleteContactCustomFieldId($contact_custom_field_id): \Itsmind\Sevdesk\Model\DeleteCheckAccount200Response

delete a contact field

Example

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


// Configure API key authorization: api_key
$config = Itsmind\Sevdesk\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Itsmind\Sevdesk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new Itsmind\Sevdesk\Api\ContactFieldApi(
    // 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
);
$contact_custom_field_id = 56; // int | Id of contact field

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

Parameters

Name	Type	Description	Notes
contact_custom_field_id	int	Id of contact field

Return type

\Itsmind\Sevdesk\Model\DeleteCheckAccount200Response

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`deleteContactFieldSetting()`

deleteContactFieldSetting($contact_custom_field_setting_id): \Itsmind\Sevdesk\Model\DeleteCheckAccount200Response

Deletes a contact field setting

Example

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


// Configure API key authorization: api_key
$config = Itsmind\Sevdesk\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Itsmind\Sevdesk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new Itsmind\Sevdesk\Api\ContactFieldApi(
    // 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
);
$contact_custom_field_setting_id = 56; // int | Id of contact field to delete

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

Parameters

Name	Type	Description	Notes
contact_custom_field_setting_id	int	Id of contact field to delete

Return type

\Itsmind\Sevdesk\Model\DeleteCheckAccount200Response

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`getContactFieldSettingById()`

getContactFieldSettingById($contact_custom_field_setting_id): \Itsmind\Sevdesk\Model\CreateContactFieldSetting200Response

Find contact field setting by ID

Returns a single contact field setting

Example

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


// Configure API key authorization: api_key
$config = Itsmind\Sevdesk\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Itsmind\Sevdesk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new Itsmind\Sevdesk\Api\ContactFieldApi(
    // 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
);
$contact_custom_field_setting_id = 56; // int | ID of contact field to return

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

Parameters

Name	Type	Description	Notes
contact_custom_field_setting_id	int	ID of contact field to return

Return type

\Itsmind\Sevdesk\Model\CreateContactFieldSetting200Response

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`getContactFieldSettings()`

getContactFieldSettings($count_all, $offset, $limit, $embed): \Itsmind\Sevdesk\Model\GetContactFieldSettings200Response

Retrieve contact field settings

Retrieve all contact field settings

Example

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


// Configure API key authorization: api_key
$config = Itsmind\Sevdesk\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Itsmind\Sevdesk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new Itsmind\Sevdesk\Api\ContactFieldApi(
    // 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
);
$count_all = True; // bool | If all objects should be counted
$offset = 56; // int | Which offset to start with
$limit = 56; // int | The max number of objects to return
$embed = array('embed_example'); // string[] | Get some additional information. Embed can handle multiple values, they must be separated by comma.

try {
    $result = $apiInstance->getContactFieldSettings($count_all, $offset, $limit, $embed);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContactFieldApi->getContactFieldSettings: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
count_all	bool	If all objects should be counted	[optional]
offset	int	Which offset to start with	[optional]
limit	int	The max number of objects to return	[optional]
embed	string[]	Get some additional information. Embed can handle multiple values, they must be separated by comma.	[optional]

Return type

\Itsmind\Sevdesk\Model\GetContactFieldSettings200Response

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`getContactFields()`

getContactFields($count_all, $offset, $limit, $embed): \Itsmind\Sevdesk\Model\GetContactFields200Response

Retrieve contact fields

Retrieve all contact fields

Example

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


// Configure API key authorization: api_key
$config = Itsmind\Sevdesk\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Itsmind\Sevdesk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new Itsmind\Sevdesk\Api\ContactFieldApi(
    // 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
);
$count_all = True; // bool | If all objects should be counted
$offset = 56; // int | Which offset to start with
$limit = 56; // int | The max number of objects to return
$embed = array('embed_example'); // string[] | Get some additional information. Embed can handle multiple values, they must be separated by comma.

try {
    $result = $apiInstance->getContactFields($count_all, $offset, $limit, $embed);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContactFieldApi->getContactFields: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
count_all	bool	If all objects should be counted	[optional]
offset	int	Which offset to start with	[optional]
limit	int	The max number of objects to return	[optional]
embed	string[]	Get some additional information. Embed can handle multiple values, they must be separated by comma.	[optional]

Return type

\Itsmind\Sevdesk\Model\GetContactFields200Response

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`getContactFieldsById()`

getContactFieldsById($contact_custom_field_id): \Itsmind\Sevdesk\Model\GetContactFieldsById200Response

Retrieve contact fields

Retrieve all contact fields

Example

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


// Configure API key authorization: api_key
$config = Itsmind\Sevdesk\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Itsmind\Sevdesk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new Itsmind\Sevdesk\Api\ContactFieldApi(
    // 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
);
$contact_custom_field_id = 3.4; // float | id of the contact field

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

Parameters

Name	Type	Description	Notes
contact_custom_field_id	float	id of the contact field

Return type

\Itsmind\Sevdesk\Model\GetContactFieldsById200Response

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`getPlaceholder()`

getPlaceholder($object_name, $sub_object_name): \Itsmind\Sevdesk\Model\GetPlaceholder200Response

Retrieve Placeholders

Retrieve all Placeholders

Example

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


// Configure API key authorization: api_key
$config = Itsmind\Sevdesk\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Itsmind\Sevdesk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new Itsmind\Sevdesk\Api\ContactFieldApi(
    // 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
);
$object_name = 'object_name_example'; // string | Model name
$sub_object_name = 'sub_object_name_example'; // string | Sub model name, required if you have \"Email\" at objectName

try {
    $result = $apiInstance->getPlaceholder($object_name, $sub_object_name);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContactFieldApi->getPlaceholder: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
object_name	string	Model name
sub_object_name	string	Sub model name, required if you have "Email" at objectName	[optional]

Return type

\Itsmind\Sevdesk\Model\GetPlaceholder200Response

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`getReferenceCount()`

getReferenceCount($contact_custom_field_setting_id): \Itsmind\Sevdesk\Model\GetReferenceCount200Response

Receive count reference

Example

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


// Configure API key authorization: api_key
$config = Itsmind\Sevdesk\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Itsmind\Sevdesk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new Itsmind\Sevdesk\Api\ContactFieldApi(
    // 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
);
$contact_custom_field_setting_id = 56; // int | ID of contact field you want to get the reference count

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

Parameters

Name	Type	Description	Notes
contact_custom_field_setting_id	int	ID of contact field you want to get the reference count

Return type

\Itsmind\Sevdesk\Model\GetReferenceCount200Response

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`updateContactFieldSetting()`

updateContactFieldSetting($contact_custom_field_setting_id, $model_contact_custom_field_setting_update): \Itsmind\Sevdesk\Model\ModelContactCustomFieldSettingResponse

Update contact field setting

Update an existing contact field setting

Example

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


// Configure API key authorization: api_key
$config = Itsmind\Sevdesk\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Itsmind\Sevdesk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new Itsmind\Sevdesk\Api\ContactFieldApi(
    // 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
);
$contact_custom_field_setting_id = 56; // int | ID of contact field setting you want to update
$model_contact_custom_field_setting_update = new \Itsmind\Sevdesk\Model\ModelContactCustomFieldSettingUpdate(); // \Itsmind\Sevdesk\Model\ModelContactCustomFieldSettingUpdate

try {
    $result = $apiInstance->updateContactFieldSetting($contact_custom_field_setting_id, $model_contact_custom_field_setting_update);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContactFieldApi->updateContactFieldSetting: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
contact_custom_field_setting_id	int	ID of contact field setting you want to update
model_contact_custom_field_setting_update	\Itsmind\Sevdesk\Model\ModelContactCustomFieldSettingUpdate		[optional]

Return type

\Itsmind\Sevdesk\Model\ModelContactCustomFieldSettingResponse

Authorization

api_key

HTTP request headers

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

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

`updateContactfield()`

updateContactfield($contact_custom_field_id, $model_contact_custom_field_update): \Itsmind\Sevdesk\Model\ModelContactCustomFieldResponse

Update a contact field

Example

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


// Configure API key authorization: api_key
$config = Itsmind\Sevdesk\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Itsmind\Sevdesk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new Itsmind\Sevdesk\Api\ContactFieldApi(
    // 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
);
$contact_custom_field_id = 3.4; // float | id of the contact field
$model_contact_custom_field_update = new \Itsmind\Sevdesk\Model\ModelContactCustomFieldUpdate(); // \Itsmind\Sevdesk\Model\ModelContactCustomFieldUpdate | Update data

try {
    $result = $apiInstance->updateContactfield($contact_custom_field_id, $model_contact_custom_field_update);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContactFieldApi->updateContactfield: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
contact_custom_field_id	float	id of the contact field
model_contact_custom_field_update	\Itsmind\Sevdesk\Model\ModelContactCustomFieldUpdate	Update data	[optional]

Return type

\Itsmind\Sevdesk\Model\ModelContactCustomFieldResponse

Authorization

api_key

HTTP request headers

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

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

Files

ContactFieldApi.md

Latest commit

History

ContactFieldApi.md

File metadata and controls

Itsmind\Sevdesk\ContactFieldApi

createContactField()

Example

Parameters

Return type

Authorization

HTTP request headers

createContactFieldSetting()

Example

Parameters

Return type

Authorization

HTTP request headers

deleteContactCustomFieldId()

Example

Parameters

Return type

Authorization

HTTP request headers

deleteContactFieldSetting()

Example

Parameters

Return type

Authorization

HTTP request headers

getContactFieldSettingById()

Example

Parameters

Return type

Authorization

HTTP request headers

getContactFieldSettings()

Example

Parameters

Return type

Authorization

HTTP request headers

getContactFields()

Example

Parameters

Return type

Authorization

HTTP request headers

getContactFieldsById()

Example

Parameters

Return type

Authorization

HTTP request headers

getPlaceholder()

Example

Parameters

Return type

Authorization

HTTP request headers

getReferenceCount()

Example

Parameters

Return type

Authorization

HTTP request headers

updateContactFieldSetting()

Example

Parameters

Return type

Authorization

HTTP request headers

updateContactfield()

Example

Parameters

Return type

Authorization

HTTP request headers

`createContactField()`

`createContactFieldSetting()`

`deleteContactCustomFieldId()`

`deleteContactFieldSetting()`

`getContactFieldSettingById()`

`getContactFieldSettings()`

`getContactFields()`

`getContactFieldsById()`

`getPlaceholder()`

`getReferenceCount()`

`updateContactFieldSetting()`

`updateContactfield()`