425 lines
16 KiB
Markdown
425 lines
16 KiB
Markdown
|
# Brevo\Client\CompaniesApi
|
||
|
|
|
||
|
|
All URIs are relative to *https://api.brevo.com/v3*
|
||
|
|
|
||
|
|
Method | HTTP request | Description
|
||
|
|
------------- | ------------- | -------------
|
||
|
|
[**companiesAttributesGet**](CompaniesApi.md#companiesAttributesGet) | **GET** /companies/attributes | Get company attributes
|
||
|
|
[**companiesGet**](CompaniesApi.md#companiesGet) | **GET** /companies | Get all companies
|
||
|
|
[**companiesIdDelete**](CompaniesApi.md#companiesIdDelete) | **DELETE** /companies/{id} | Delete a company
|
||
|
|
[**companiesIdGet**](CompaniesApi.md#companiesIdGet) | **GET** /companies/{id} | Get a company
|
||
|
|
[**companiesIdPatch**](CompaniesApi.md#companiesIdPatch) | **PATCH** /companies/{id} | Update a company
|
||
|
|
[**companiesLinkUnlinkIdPatch**](CompaniesApi.md#companiesLinkUnlinkIdPatch) | **PATCH** /companies/link-unlink/{id} | Link and Unlink company with contacts and deals
|
||
|
|
[**companiesPost**](CompaniesApi.md#companiesPost) | **POST** /companies | Create a company
|
||
|
|
|
||
|
|
|
||
|
|
# **companiesAttributesGet**
|
||
|
|
> \Brevo\Client\Model\CompanyAttributes companiesAttributesGet()
|
||
|
|
|
||
|
|
Get company attributes
|
||
|
|
|
||
|
|
### Example
|
||
|
|
```php
|
||
|
|
<?php
|
||
|
|
require_once(__DIR__ . '/vendor/autoload.php');
|
||
|
|
|
||
|
|
// Configure API key authorization: api-key
|
||
|
|
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||
|
|
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||
|
|
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||
|
|
// Configure API key authorization: partner-key
|
||
|
|
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||
|
|
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||
|
|
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||
|
|
|
||
|
|
$apiInstance = new Brevo\Client\Api\CompaniesApi(
|
||
|
|
// 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
|
||
|
|
);
|
||
|
|
|
||
|
|
try {
|
||
|
|
$result = $apiInstance->companiesAttributesGet();
|
||
|
|
print_r($result);
|
||
|
|
} catch (Exception $e) {
|
||
|
|
echo 'Exception when calling CompaniesApi->companiesAttributesGet: ', $e->getMessage(), PHP_EOL;
|
||
|
|
}
|
||
|
|
?>
|
||
|
|
```
|
||
|
|
|
||
|
|
### Parameters
|
||
|
|
This endpoint does not need any parameter.
|
||
|
|
|
||
|
|
### Return type
|
||
|
|
|
||
|
|
[**\Brevo\Client\Model\CompanyAttributes**](../Model/CompanyAttributes.md)
|
||
|
|
|
||
|
|
### Authorization
|
||
|
|
|
||
|
|
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||
|
|
|
||
|
|
### HTTP request headers
|
||
|
|
|
||
|
|
- **Content-Type**: application/json
|
||
|
|
- **Accept**: application/json
|
||
|
|
|
||
|
|
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||
|
|
|
||
|
|
# **companiesGet**
|
||
|
|
> \Brevo\Client\Model\CompaniesList companiesGet($filters, $linkedContactsIds, $linkedDealsIds, $page, $limit, $sort, $sortBy)
|
||
|
|
|
||
|
|
Get all companies
|
||
|
|
|
||
|
|
### Example
|
||
|
|
```php
|
||
|
|
<?php
|
||
|
|
require_once(__DIR__ . '/vendor/autoload.php');
|
||
|
|
|
||
|
|
// Configure API key authorization: api-key
|
||
|
|
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||
|
|
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||
|
|
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||
|
|
// Configure API key authorization: partner-key
|
||
|
|
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||
|
|
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||
|
|
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||
|
|
|
||
|
|
$apiInstance = new Brevo\Client\Api\CompaniesApi(
|
||
|
|
// 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
|
||
|
|
);
|
||
|
|
$filters = "filters_example"; // string | Filter by attrbutes. If you have filter for owner on your side please send it as {\"attributes.owner\":\"5b1a17d914b73d35a76ca0c7\"}
|
||
|
|
$linkedContactsIds = 789; // int | Filter by linked contacts ids
|
||
|
|
$linkedDealsIds = "linkedDealsIds_example"; // string | Filter by linked deals ids
|
||
|
|
$page = 789; // int | Index of the first document of the page
|
||
|
|
$limit = 50; // int | Number of documents per page
|
||
|
|
$sort = "sort_example"; // string | Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed
|
||
|
|
$sortBy = "sortBy_example"; // string | The field used to sort field names.
|
||
|
|
|
||
|
|
try {
|
||
|
|
$result = $apiInstance->companiesGet($filters, $linkedContactsIds, $linkedDealsIds, $page, $limit, $sort, $sortBy);
|
||
|
|
print_r($result);
|
||
|
|
} catch (Exception $e) {
|
||
|
|
echo 'Exception when calling CompaniesApi->companiesGet: ', $e->getMessage(), PHP_EOL;
|
||
|
|
}
|
||
|
|
?>
|
||
|
|
```
|
||
|
|
|
||
|
|
### Parameters
|
||
|
|
|
||
|
|
Name | Type | Description | Notes
|
||
|
|
------------- | ------------- | ------------- | -------------
|
||
|
|
**filters** | **string**| Filter by attrbutes. If you have filter for owner on your side please send it as {\"attributes.owner\":\"5b1a17d914b73d35a76ca0c7\"} | [optional]
|
||
|
|
**linkedContactsIds** | **int**| Filter by linked contacts ids | [optional]
|
||
|
|
**linkedDealsIds** | **string**| Filter by linked deals ids | [optional]
|
||
|
|
**page** | **int**| Index of the first document of the page | [optional]
|
||
|
|
**limit** | **int**| Number of documents per page | [optional] [default to 50]
|
||
|
|
**sort** | **string**| Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed | [optional]
|
||
|
|
**sortBy** | **string**| The field used to sort field names. | [optional]
|
||
|
|
|
||
|
|
### Return type
|
||
|
|
|
||
|
|
[**\Brevo\Client\Model\CompaniesList**](../Model/CompaniesList.md)
|
||
|
|
|
||
|
|
### Authorization
|
||
|
|
|
||
|
|
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||
|
|
|
||
|
|
### HTTP request headers
|
||
|
|
|
||
|
|
- **Content-Type**: application/json
|
||
|
|
- **Accept**: application/json
|
||
|
|
|
||
|
|
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||
|
|
|
||
|
|
# **companiesIdDelete**
|
||
|
|
> companiesIdDelete($id)
|
||
|
|
|
||
|
|
Delete a company
|
||
|
|
|
||
|
|
### Example
|
||
|
|
```php
|
||
|
|
<?php
|
||
|
|
require_once(__DIR__ . '/vendor/autoload.php');
|
||
|
|
|
||
|
|
// Configure API key authorization: api-key
|
||
|
|
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||
|
|
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||
|
|
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||
|
|
// Configure API key authorization: partner-key
|
||
|
|
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||
|
|
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||
|
|
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||
|
|
|
||
|
|
$apiInstance = new Brevo\Client\Api\CompaniesApi(
|
||
|
|
// 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
|
||
|
|
);
|
||
|
|
$id = "id_example"; // string |
|
||
|
|
|
||
|
|
try {
|
||
|
|
$apiInstance->companiesIdDelete($id);
|
||
|
|
} catch (Exception $e) {
|
||
|
|
echo 'Exception when calling CompaniesApi->companiesIdDelete: ', $e->getMessage(), PHP_EOL;
|
||
|
|
}
|
||
|
|
?>
|
||
|
|
```
|
||
|
|
|
||
|
|
### Parameters
|
||
|
|
|
||
|
|
Name | Type | Description | Notes
|
||
|
|
------------- | ------------- | ------------- | -------------
|
||
|
|
**id** | **string**| |
|
||
|
|
|
||
|
|
### Return type
|
||
|
|
|
||
|
|
void (empty response body)
|
||
|
|
|
||
|
|
### Authorization
|
||
|
|
|
||
|
|
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||
|
|
|
||
|
|
### HTTP request headers
|
||
|
|
|
||
|
|
- **Content-Type**: application/json
|
||
|
|
- **Accept**: application/json
|
||
|
|
|
||
|
|
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||
|
|
|
||
|
|
# **companiesIdGet**
|
||
|
|
> \Brevo\Client\Model\Company companiesIdGet($id)
|
||
|
|
|
||
|
|
Get a company
|
||
|
|
|
||
|
|
### Example
|
||
|
|
```php
|
||
|
|
<?php
|
||
|
|
require_once(__DIR__ . '/vendor/autoload.php');
|
||
|
|
|
||
|
|
// Configure API key authorization: api-key
|
||
|
|
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||
|
|
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||
|
|
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||
|
|
// Configure API key authorization: partner-key
|
||
|
|
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||
|
|
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||
|
|
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||
|
|
|
||
|
|
$apiInstance = new Brevo\Client\Api\CompaniesApi(
|
||
|
|
// 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
|
||
|
|
);
|
||
|
|
$id = "id_example"; // string |
|
||
|
|
|
||
|
|
try {
|
||
|
|
$result = $apiInstance->companiesIdGet($id);
|
||
|
|
print_r($result);
|
||
|
|
} catch (Exception $e) {
|
||
|
|
echo 'Exception when calling CompaniesApi->companiesIdGet: ', $e->getMessage(), PHP_EOL;
|
||
|
|
}
|
||
|
|
?>
|
||
|
|
```
|
||
|
|
|
||
|
|
### Parameters
|
||
|
|
|
||
|
|
Name | Type | Description | Notes
|
||
|
|
------------- | ------------- | ------------- | -------------
|
||
|
|
**id** | **string**| |
|
||
|
|
|
||
|
|
### Return type
|
||
|
|
|
||
|
|
[**\Brevo\Client\Model\Company**](../Model/Company.md)
|
||
|
|
|
||
|
|
### Authorization
|
||
|
|
|
||
|
|
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||
|
|
|
||
|
|
### HTTP request headers
|
||
|
|
|
||
|
|
- **Content-Type**: application/json
|
||
|
|
- **Accept**: application/json
|
||
|
|
|
||
|
|
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||
|
|
|
||
|
|
# **companiesIdPatch**
|
||
|
|
> \Brevo\Client\Model\Company companiesIdPatch($id, $body)
|
||
|
|
|
||
|
|
Update a company
|
||
|
|
|
||
|
|
### Example
|
||
|
|
```php
|
||
|
|
<?php
|
||
|
|
require_once(__DIR__ . '/vendor/autoload.php');
|
||
|
|
|
||
|
|
// Configure API key authorization: api-key
|
||
|
|
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||
|
|
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||
|
|
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||
|
|
// Configure API key authorization: partner-key
|
||
|
|
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||
|
|
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||
|
|
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||
|
|
|
||
|
|
$apiInstance = new Brevo\Client\Api\CompaniesApi(
|
||
|
|
// 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
|
||
|
|
);
|
||
|
|
$id = "id_example"; // string |
|
||
|
|
$body = new \Brevo\Client\Model\Body3(); // \Brevo\Client\Model\Body3 | Updated company details.
|
||
|
|
|
||
|
|
try {
|
||
|
|
$result = $apiInstance->companiesIdPatch($id, $body);
|
||
|
|
print_r($result);
|
||
|
|
} catch (Exception $e) {
|
||
|
|
echo 'Exception when calling CompaniesApi->companiesIdPatch: ', $e->getMessage(), PHP_EOL;
|
||
|
|
}
|
||
|
|
?>
|
||
|
|
```
|
||
|
|
|
||
|
|
### Parameters
|
||
|
|
|
||
|
|
Name | Type | Description | Notes
|
||
|
|
------------- | ------------- | ------------- | -------------
|
||
|
|
**id** | **string**| |
|
||
|
|
**body** | [**\Brevo\Client\Model\Body3**](../Model/Body3.md)| Updated company details. |
|
||
|
|
|
||
|
|
### Return type
|
||
|
|
|
||
|
|
[**\Brevo\Client\Model\Company**](../Model/Company.md)
|
||
|
|
|
||
|
|
### Authorization
|
||
|
|
|
||
|
|
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||
|
|
|
||
|
|
### HTTP request headers
|
||
|
|
|
||
|
|
- **Content-Type**: application/json
|
||
|
|
- **Accept**: application/json
|
||
|
|
|
||
|
|
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||
|
|
|
||
|
|
# **companiesLinkUnlinkIdPatch**
|
||
|
|
> companiesLinkUnlinkIdPatch($id, $body)
|
||
|
|
|
||
|
|
Link and Unlink company with contacts and deals
|
||
|
|
|
||
|
|
### Example
|
||
|
|
```php
|
||
|
|
<?php
|
||
|
|
require_once(__DIR__ . '/vendor/autoload.php');
|
||
|
|
|
||
|
|
// Configure API key authorization: api-key
|
||
|
|
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||
|
|
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||
|
|
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||
|
|
// Configure API key authorization: partner-key
|
||
|
|
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||
|
|
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||
|
|
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||
|
|
|
||
|
|
$apiInstance = new Brevo\Client\Api\CompaniesApi(
|
||
|
|
// 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
|
||
|
|
);
|
||
|
|
$id = "id_example"; // string |
|
||
|
|
$body = new \Brevo\Client\Model\Body4(); // \Brevo\Client\Model\Body4 | Linked / Unlinked contacts and deals ids.
|
||
|
|
|
||
|
|
try {
|
||
|
|
$apiInstance->companiesLinkUnlinkIdPatch($id, $body);
|
||
|
|
} catch (Exception $e) {
|
||
|
|
echo 'Exception when calling CompaniesApi->companiesLinkUnlinkIdPatch: ', $e->getMessage(), PHP_EOL;
|
||
|
|
}
|
||
|
|
?>
|
||
|
|
```
|
||
|
|
|
||
|
|
### Parameters
|
||
|
|
|
||
|
|
Name | Type | Description | Notes
|
||
|
|
------------- | ------------- | ------------- | -------------
|
||
|
|
**id** | **string**| |
|
||
|
|
**body** | [**\Brevo\Client\Model\Body4**](../Model/Body4.md)| Linked / Unlinked contacts and deals ids. |
|
||
|
|
|
||
|
|
### Return type
|
||
|
|
|
||
|
|
void (empty response body)
|
||
|
|
|
||
|
|
### Authorization
|
||
|
|
|
||
|
|
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||
|
|
|
||
|
|
### HTTP request headers
|
||
|
|
|
||
|
|
- **Content-Type**: application/json
|
||
|
|
- **Accept**: application/json
|
||
|
|
|
||
|
|
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||
|
|
|
||
|
|
# **companiesPost**
|
||
|
|
> \Brevo\Client\Model\InlineResponse2001 companiesPost($body)
|
||
|
|
|
||
|
|
Create a company
|
||
|
|
|
||
|
|
### Example
|
||
|
|
```php
|
||
|
|
<?php
|
||
|
|
require_once(__DIR__ . '/vendor/autoload.php');
|
||
|
|
|
||
|
|
// Configure API key authorization: api-key
|
||
|
|
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
|
||
|
|
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||
|
|
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
|
||
|
|
// Configure API key authorization: partner-key
|
||
|
|
$config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
|
||
|
|
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||
|
|
// $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');
|
||
|
|
|
||
|
|
$apiInstance = new Brevo\Client\Api\CompaniesApi(
|
||
|
|
// 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
|
||
|
|
);
|
||
|
|
$body = new \Brevo\Client\Model\Body2(); // \Brevo\Client\Model\Body2 | Company create data.
|
||
|
|
|
||
|
|
try {
|
||
|
|
$result = $apiInstance->companiesPost($body);
|
||
|
|
print_r($result);
|
||
|
|
} catch (Exception $e) {
|
||
|
|
echo 'Exception when calling CompaniesApi->companiesPost: ', $e->getMessage(), PHP_EOL;
|
||
|
|
}
|
||
|
|
?>
|
||
|
|
```
|
||
|
|
|
||
|
|
### Parameters
|
||
|
|
|
||
|
|
Name | Type | Description | Notes
|
||
|
|
------------- | ------------- | ------------- | -------------
|
||
|
|
**body** | [**\Brevo\Client\Model\Body2**](../Model/Body2.md)| Company create data. |
|
||
|
|
|
||
|
|
### Return type
|
||
|
|
|
||
|
|
[**\Brevo\Client\Model\InlineResponse2001**](../Model/InlineResponse2001.md)
|
||
|
|
|
||
|
|
### Authorization
|
||
|
|
|
||
|
|
[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)
|
||
|
|
|
||
|
|
### HTTP request headers
|
||
|
|
|
||
|
|
- **Content-Type**: application/json
|
||
|
|
- **Accept**: application/json
|
||
|
|
|
||
|
|
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
|
||
|
|
|