# EgoiClient\ContactsApi All URIs are relative to *https://api.egoiapp.com* Method | HTTP request | Description ------------- | ------------- | ------------- [**actionActivateContacts**](ContactsApi.md#actionActivateContacts) | **POST** /lists/{list_id}/contacts/actions/activate | Activate contacts [**actionAttachTag**](ContactsApi.md#actionAttachTag) | **POST** /lists/{list_id}/contacts/actions/attach-tag | Attach tag to contact [**actionDeactivateContacts**](ContactsApi.md#actionDeactivateContacts) | **POST** /lists/{list_id}/contacts/actions/deactivate | Deactivate contacts [**actionDetachTag**](ContactsApi.md#actionDetachTag) | **POST** /lists/{list_id}/contacts/actions/detach-tag | Detach tag to contact [**actionExportContacts**](ContactsApi.md#actionExportContacts) | **POST** /lists/{list_id}/contacts/actions/export | Exports a list of contacts [**actionForgetContacts**](ContactsApi.md#actionForgetContacts) | **POST** /lists/{list_id}/contacts/actions/forget | Forget contacts [**actionImportBulk**](ContactsApi.md#actionImportBulk) | **POST** /lists/{list_id}/contacts/actions/import-bulk | Import collection of contacts [**actionStartAutomation**](ContactsApi.md#actionStartAutomation) | **POST** /lists/{list_id}/contacts/actions/start-automation | Start automation [**actionUnsubscribeContact**](ContactsApi.md#actionUnsubscribeContact) | **POST** /lists/{list_id}/contacts/actions/unsubscribe | Unsubscribes contacts [**createContact**](ContactsApi.md#createContact) | **POST** /lists/{list_id}/contacts | Create new contact [**getAllContactActivities**](ContactsApi.md#getAllContactActivities) | **GET** /lists/{list_id}/contacts/{contact_id}/activities | Get all contact activities [**getAllContacts**](ContactsApi.md#getAllContacts) | **GET** /lists/{list_id}/contacts | Get all contacts [**getContact**](ContactsApi.md#getContact) | **GET** /lists/{list_id}/contacts/{contact_id} | Get contact [**patchContact**](ContactsApi.md#patchContact) | **PATCH** /lists/{list_id}/contacts/{contact_id} | Update a specific contact [**searchContacts**](ContactsApi.md#searchContacts) | **GET** /contacts/search | Search contact ## actionActivateContacts > \EgoiClient\EgoiModel\AcceptedResponse actionActivateContacts($list_id, $activate_contacts_request) Activate contacts Activates a collection of contacts (does not apply to removed contacts) ### Example ```php setApiKey('Apikey', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = EgoiClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer'); $apiInstance = new EgoiClient\Api\ContactsApi( // 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 ); $list_id = 56; // int | ID of the List $activate_contacts_request = new \EgoiClient\EgoiModel\ActivateContactsRequest(); // \EgoiClient\EgoiModel\ActivateContactsRequest | Parameters for the request try { $result = $apiInstance->actionActivateContacts($list_id, $activate_contacts_request); print_r($result); } catch (Exception $e) { echo 'Exception when calling ContactsApi->actionActivateContacts: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **list_id** | **int**| ID of the List | **activate_contacts_request** | [**\EgoiClient\EgoiModel\ActivateContactsRequest**](../Model/ActivateContactsRequest.md)| Parameters for the request | ### Return type [**\EgoiClient\EgoiModel\AcceptedResponse**](../Model/AcceptedResponse.md) ### Authorization [Apikey](../../README.md#Apikey) ### 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) ## actionAttachTag > \EgoiClient\EgoiModel\AttachTagResponse actionAttachTag($list_id, $attach_tag_request) Attach tag to contact Attaches a tag to the provided contacts ### Example ```php setApiKey('Apikey', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = EgoiClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer'); $apiInstance = new EgoiClient\Api\ContactsApi( // 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 ); $list_id = 56; // int | ID of the List $attach_tag_request = new \EgoiClient\EgoiModel\AttachTagRequest(); // \EgoiClient\EgoiModel\AttachTagRequest | Parameters for the Tag try { $result = $apiInstance->actionAttachTag($list_id, $attach_tag_request); print_r($result); } catch (Exception $e) { echo 'Exception when calling ContactsApi->actionAttachTag: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **list_id** | **int**| ID of the List | **attach_tag_request** | [**\EgoiClient\EgoiModel\AttachTagRequest**](../Model/AttachTagRequest.md)| Parameters for the Tag | ### Return type [**\EgoiClient\EgoiModel\AttachTagResponse**](../Model/AttachTagResponse.md) ### Authorization [Apikey](../../README.md#Apikey) ### 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) ## actionDeactivateContacts > \EgoiClient\EgoiModel\AcceptedResponse actionDeactivateContacts($list_id, $deactivate_contacts_request) Deactivate contacts Deactivates a collection of contacts (does not apply to removed contacts) ### Example ```php setApiKey('Apikey', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = EgoiClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer'); $apiInstance = new EgoiClient\Api\ContactsApi( // 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 ); $list_id = 56; // int | ID of the List $deactivate_contacts_request = new \EgoiClient\EgoiModel\DeactivateContactsRequest(); // \EgoiClient\EgoiModel\DeactivateContactsRequest | Parameters for the request try { $result = $apiInstance->actionDeactivateContacts($list_id, $deactivate_contacts_request); print_r($result); } catch (Exception $e) { echo 'Exception when calling ContactsApi->actionDeactivateContacts: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **list_id** | **int**| ID of the List | **deactivate_contacts_request** | [**\EgoiClient\EgoiModel\DeactivateContactsRequest**](../Model/DeactivateContactsRequest.md)| Parameters for the request | ### Return type [**\EgoiClient\EgoiModel\AcceptedResponse**](../Model/AcceptedResponse.md) ### Authorization [Apikey](../../README.md#Apikey) ### 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) ## actionDetachTag > \EgoiClient\EgoiModel\AttachTagResponse actionDetachTag($list_id, $attach_tag_request) Detach tag to contact Detach a tag to the provided contacts ### Example ```php setApiKey('Apikey', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = EgoiClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer'); $apiInstance = new EgoiClient\Api\ContactsApi( // 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 ); $list_id = 56; // int | ID of the List $attach_tag_request = new \EgoiClient\EgoiModel\AttachTagRequest(); // \EgoiClient\EgoiModel\AttachTagRequest | Parameters for the Tag try { $result = $apiInstance->actionDetachTag($list_id, $attach_tag_request); print_r($result); } catch (Exception $e) { echo 'Exception when calling ContactsApi->actionDetachTag: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **list_id** | **int**| ID of the List | **attach_tag_request** | [**\EgoiClient\EgoiModel\AttachTagRequest**](../Model/AttachTagRequest.md)| Parameters for the Tag | ### Return type [**\EgoiClient\EgoiModel\AttachTagResponse**](../Model/AttachTagResponse.md) ### Authorization [Apikey](../../README.md#Apikey) ### 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) ## actionExportContacts > \EgoiClient\EgoiModel\AcceptedResponse actionExportContacts($list_id, $contact_export_request) Exports a list of contacts Exports a list of contacts to the desired callback url ### Example ```php setApiKey('Apikey', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = EgoiClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer'); $apiInstance = new EgoiClient\Api\ContactsApi( // 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 ); $list_id = 56; // int | ID of the List $contact_export_request = new \EgoiClient\EgoiModel\ContactExportRequest(); // \EgoiClient\EgoiModel\ContactExportRequest | Parameters for export try { $result = $apiInstance->actionExportContacts($list_id, $contact_export_request); print_r($result); } catch (Exception $e) { echo 'Exception when calling ContactsApi->actionExportContacts: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **list_id** | **int**| ID of the List | **contact_export_request** | [**\EgoiClient\EgoiModel\ContactExportRequest**](../Model/ContactExportRequest.md)| Parameters for export | ### Return type [**\EgoiClient\EgoiModel\AcceptedResponse**](../Model/AcceptedResponse.md) ### Authorization [Apikey](../../README.md#Apikey) ### 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) ## actionForgetContacts > \EgoiClient\EgoiModel\AcceptedResponse actionForgetContacts($list_id, $contact_forget_request) Forget contacts Forgets a list of contacts to the desired callback url ### Example ```php setApiKey('Apikey', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = EgoiClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer'); $apiInstance = new EgoiClient\Api\ContactsApi( // 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 ); $list_id = 56; // int | ID of the List $contact_forget_request = new \EgoiClient\EgoiModel\ContactForgetRequest(); // \EgoiClient\EgoiModel\ContactForgetRequest | Parameters for the action try { $result = $apiInstance->actionForgetContacts($list_id, $contact_forget_request); print_r($result); } catch (Exception $e) { echo 'Exception when calling ContactsApi->actionForgetContacts: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **list_id** | **int**| ID of the List | **contact_forget_request** | [**\EgoiClient\EgoiModel\ContactForgetRequest**](../Model/ContactForgetRequest.md)| Parameters for the action | ### Return type [**\EgoiClient\EgoiModel\AcceptedResponse**](../Model/AcceptedResponse.md) ### Authorization [Apikey](../../README.md#Apikey) ### 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) ## actionImportBulk > \EgoiClient\EgoiModel\AcceptedResponse actionImportBulk($list_id, $import_bulk_request) Import collection of contacts Imports a collection of contacts
**DISCLAIMER:** stream limits applied. [view here](#section/Stream-Limits 'Stream Limits') ### Example ```php setApiKey('Apikey', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = EgoiClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer'); $apiInstance = new EgoiClient\Api\ContactsApi( // 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 ); $list_id = 56; // int | ID of the List $import_bulk_request = new \EgoiClient\EgoiModel\ImportBulkRequest(); // \EgoiClient\EgoiModel\ImportBulkRequest | Parameters for the bulk import try { $result = $apiInstance->actionImportBulk($list_id, $import_bulk_request); print_r($result); } catch (Exception $e) { echo 'Exception when calling ContactsApi->actionImportBulk: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **list_id** | **int**| ID of the List | **import_bulk_request** | [**\EgoiClient\EgoiModel\ImportBulkRequest**](../Model/ImportBulkRequest.md)| Parameters for the bulk import | ### Return type [**\EgoiClient\EgoiModel\AcceptedResponse**](../Model/AcceptedResponse.md) ### Authorization [Apikey](../../README.md#Apikey) ### 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) ## actionStartAutomation > \EgoiClient\EgoiModel\StartAutomationResponse actionStartAutomation($list_id, $start_automation_request) Start automation Start automation to the provided contacts ### Example ```php setApiKey('Apikey', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = EgoiClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer'); $apiInstance = new EgoiClient\Api\ContactsApi( // 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 ); $list_id = 56; // int | ID of the List $start_automation_request = new \EgoiClient\EgoiModel\StartAutomationRequest(); // \EgoiClient\EgoiModel\StartAutomationRequest | Parameters for the operation to start automation try { $result = $apiInstance->actionStartAutomation($list_id, $start_automation_request); print_r($result); } catch (Exception $e) { echo 'Exception when calling ContactsApi->actionStartAutomation: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **list_id** | **int**| ID of the List | **start_automation_request** | [**\EgoiClient\EgoiModel\StartAutomationRequest**](../Model/StartAutomationRequest.md)| Parameters for the operation to start automation | ### Return type [**\EgoiClient\EgoiModel\StartAutomationResponse**](../Model/StartAutomationResponse.md) ### Authorization [Apikey](../../README.md#Apikey) ### 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) ## actionUnsubscribeContact > \EgoiClient\EgoiModel\RemoveResponse actionUnsubscribeContact($list_id, $remove_request) Unsubscribes contacts Unsubscribes contacts ### Example ```php setApiKey('Apikey', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = EgoiClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer'); $apiInstance = new EgoiClient\Api\ContactsApi( // 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 ); $list_id = 56; // int | ID of the List $remove_request = new \EgoiClient\EgoiModel\RemoveRequest(); // \EgoiClient\EgoiModel\RemoveRequest | Parameters for the contact to unsubscribe try { $result = $apiInstance->actionUnsubscribeContact($list_id, $remove_request); print_r($result); } catch (Exception $e) { echo 'Exception when calling ContactsApi->actionUnsubscribeContact: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **list_id** | **int**| ID of the List | **remove_request** | [**\EgoiClient\EgoiModel\RemoveRequest**](../Model/RemoveRequest.md)| Parameters for the contact to unsubscribe | ### Return type [**\EgoiClient\EgoiModel\RemoveResponse**](../Model/RemoveResponse.md) ### Authorization [Apikey](../../README.md#Apikey) ### 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) ## createContact > \EgoiClient\EgoiModel\CreateContactResponse createContact($list_id, $contact_base_extra) Create new contact Create a new contact ### Example ```php setApiKey('Apikey', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = EgoiClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer'); $apiInstance = new EgoiClient\Api\ContactsApi( // 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 ); $list_id = 56; // int | ID of the list where the contact belongs $contact_base_extra = new \EgoiClient\EgoiModel\ContactBaseExtra(); // \EgoiClient\EgoiModel\ContactBaseExtra | Parameters for the Contact try { $result = $apiInstance->createContact($list_id, $contact_base_extra); print_r($result); } catch (Exception $e) { echo 'Exception when calling ContactsApi->createContact: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **list_id** | **int**| ID of the list where the contact belongs | **contact_base_extra** | [**\EgoiClient\EgoiModel\ContactBaseExtra**](../Model/ContactBaseExtra.md)| Parameters for the Contact | ### Return type [**\EgoiClient\EgoiModel\CreateContactResponse**](../Model/CreateContactResponse.md) ### Authorization [Apikey](../../README.md#Apikey) ### 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) ## getAllContactActivities > \EgoiClient\EgoiModel\ActivityCollection getAllContactActivities($contact_id, $list_id, $offset, $limit, $date_min, $date_max) Get all contact activities Returns all contact activities ### Example ```php setApiKey('Apikey', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = EgoiClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer'); $apiInstance = new EgoiClient\Api\ContactsApi( // 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_id = 'contact_id_example'; // string | ID of the Contact $list_id = 56; // int | ID of the List $offset = 56; // int | Element offset (starting at zero for the first element) $limit = 10; // int | Number of items to return $date_min = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | Start date $date_max = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | End date try { $result = $apiInstance->getAllContactActivities($contact_id, $list_id, $offset, $limit, $date_min, $date_max); print_r($result); } catch (Exception $e) { echo 'Exception when calling ContactsApi->getAllContactActivities: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **contact_id** | **string**| ID of the Contact | **list_id** | **int**| ID of the List | **offset** | **int**| Element offset (starting at zero for the first element) | [optional] **limit** | **int**| Number of items to return | [optional] [default to 10] **date_min** | **\DateTime**| Start date | [optional] **date_max** | **\DateTime**| End date | [optional] ### Return type [**\EgoiClient\EgoiModel\ActivityCollection**](../Model/ActivityCollection.md) ### Authorization [Apikey](../../README.md#Apikey) ### HTTP request headers - **Content-Type**: Not defined - **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) ## getAllContacts > \EgoiClient\EgoiModel\ContactCollection getAllContacts($list_id, $offset, $limit, $email) Get all contacts Returns all contacts ### Example ```php setApiKey('Apikey', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = EgoiClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer'); $apiInstance = new EgoiClient\Api\ContactsApi( // 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 ); $list_id = 56; // int | ID of the List $offset = 56; // int | Element offset (starting at zero for the first element) $limit = 10; // int | Number of items to return $email = 'email_example'; // string | Email of the contacts to return try { $result = $apiInstance->getAllContacts($list_id, $offset, $limit, $email); print_r($result); } catch (Exception $e) { echo 'Exception when calling ContactsApi->getAllContacts: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **list_id** | **int**| ID of the List | **offset** | **int**| Element offset (starting at zero for the first element) | [optional] **limit** | **int**| Number of items to return | [optional] [default to 10] **email** | **string**| Email of the contacts to return | [optional] ### Return type [**\EgoiClient\EgoiModel\ContactCollection**](../Model/ContactCollection.md) ### Authorization [Apikey](../../README.md#Apikey) ### HTTP request headers - **Content-Type**: Not defined - **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) ## getContact > \EgoiClient\EgoiModel\ComplexContact getContact($contact_id, $list_id) Get contact Returns contact information given its ID ### Example ```php setApiKey('Apikey', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = EgoiClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer'); $apiInstance = new EgoiClient\Api\ContactsApi( // 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_id = 'contact_id_example'; // string | ID of the Contact $list_id = 56; // int | ID of the List try { $result = $apiInstance->getContact($contact_id, $list_id); print_r($result); } catch (Exception $e) { echo 'Exception when calling ContactsApi->getContact: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **contact_id** | **string**| ID of the Contact | **list_id** | **int**| ID of the List | ### Return type [**\EgoiClient\EgoiModel\ComplexContact**](../Model/ComplexContact.md) ### Authorization [Apikey](../../README.md#Apikey) ### HTTP request headers - **Content-Type**: Not defined - **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) ## patchContact > \EgoiClient\EgoiModel\CreateContactResponse patchContact($contact_id, $list_id, $contact_base_status_extra) Update a specific contact Update contact ### Example ```php setApiKey('Apikey', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = EgoiClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer'); $apiInstance = new EgoiClient\Api\ContactsApi( // 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_id = 'contact_id_example'; // string | ID of the Contact $list_id = 56; // int | ID of the List $contact_base_status_extra = new \EgoiClient\EgoiModel\ContactBaseStatusExtra(); // \EgoiClient\EgoiModel\ContactBaseStatusExtra | Parameters for the contact try { $result = $apiInstance->patchContact($contact_id, $list_id, $contact_base_status_extra); print_r($result); } catch (Exception $e) { echo 'Exception when calling ContactsApi->patchContact: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **contact_id** | **string**| ID of the Contact | **list_id** | **int**| ID of the List | **contact_base_status_extra** | [**\EgoiClient\EgoiModel\ContactBaseStatusExtra**](../Model/ContactBaseStatusExtra.md)| Parameters for the contact | ### Return type [**\EgoiClient\EgoiModel\CreateContactResponse**](../Model/CreateContactResponse.md) ### Authorization [Apikey](../../README.md#Apikey) ### 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) ## searchContacts > \EgoiClient\EgoiModel\InlineResponse200 searchContacts($contact, $type) Search contact Searches a contact across all lists and returns a collection of contacts found ### Example ```php setApiKey('Apikey', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = EgoiClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer'); $apiInstance = new EgoiClient\Api\ContactsApi( // 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 = 'contact_example'; // string | Contact to search $type = 'email'; // string | Type of contact to search (defaults to 'email') try { $result = $apiInstance->searchContacts($contact, $type); print_r($result); } catch (Exception $e) { echo 'Exception when calling ContactsApi->searchContacts: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **contact** | **string**| Contact to search | **type** | **string**| Type of contact to search (defaults to 'email') | [optional] [default to 'email'] ### Return type [**\EgoiClient\EgoiModel\InlineResponse200**](../Model/InlineResponse200.md) ### Authorization [Apikey](../../README.md#Apikey) ### HTTP request headers - **Content-Type**: Not defined - **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)