Skip to content

Latest commit

 

History

History
129 lines (88 loc) · 4.17 KB

ContactsApi.md

File metadata and controls

129 lines (88 loc) · 4.17 KB
Raw

Equisoft\SDK\EquisoftConnect\ContactsApi

All URIs are relative to http://localhost, except if the operation defines another base path.

Method HTTP request Description
getByUuid() GET /crm/api/v1/contacts/{contactUuid} Return the detail of a contact.
patchContact() PATCH /crm/api/v1/contacts/{contactUuid} Update a contact

getByUuid()

getByUuid($contactUuid, $acceptLanguage): \Equisoft\SDK\EquisoftConnect\Model\ContactsContact

Return the detail of a contact.

Example

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


// Configure OAuth2 access token for authorization: OAuth2
$config = Equisoft\SDK\EquisoftConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Equisoft\SDK\EquisoftConnect\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
);
$contactUuid = 'contactUuid_example'; // string | Contact unique identifier.
$acceptLanguage = 'acceptLanguage_example'; // string | Specify preferred language for returned data. Format is https://tools.ietf.org/html/rfc3282.

try {
    $result = $apiInstance->getByUuid($contactUuid, $acceptLanguage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContactsApi->getByUuid: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
contactUuid string Contact unique identifier.
acceptLanguage string Specify preferred language for returned data. Format is https://tools.ietf.org/html/rfc3282. [optional]

Return type

\Equisoft\SDK\EquisoftConnect\Model\ContactsContact

Authorization

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]

patchContact()

patchContact($contactUuid, $contactPatchContactPayload): \Equisoft\SDK\EquisoftConnect\Model\ContactsContact

Update a contact

Example

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


// Configure OAuth2 access token for authorization: OAuth2
$config = Equisoft\SDK\EquisoftConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Equisoft\SDK\EquisoftConnect\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
);
$contactUuid = 'contactUuid_example'; // string | Contact unique identifier.
$contactPatchContactPayload = new \Equisoft\SDK\EquisoftConnect\Model\ContactPatchContactPayload(); // \Equisoft\SDK\EquisoftConnect\Model\ContactPatchContactPayload

try {
    $result = $apiInstance->patchContact($contactUuid, $contactPatchContactPayload);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContactsApi->patchContact: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
contactUuid string Contact unique identifier.
contactPatchContactPayload \Equisoft\SDK\EquisoftConnect\Model\ContactPatchContactPayload

Return type

\Equisoft\SDK\EquisoftConnect\Model\ContactsContact

Authorization

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]