Skip to content

README.md

Latest commit

 

History

History
66 lines (45 loc) · 3.52 KB

README.md

File metadata and controls

66 lines (45 loc) · 3.52 KB

Vault.CustomMappings

Overview

Available Operations

  • list - List custom mappings

list

This endpoint returns a list of custom mappings.

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use Apideck\Unify;

$sdk = Unify\Apideck::builder()
    ->setConsumerId('test-consumer')
    ->setAppId('dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX')
    ->setSecurity(
        '<YOUR_BEARER_TOKEN_HERE>'
    )
    ->build();



$response = $sdk->vault->customMappings->list(
    unifiedApi: 'crm',
    serviceId: 'pipedrive'

);

if ($response->getCustomMappingsResponse !== null) {
    // handle response
}

Parameters

Parameter Type Required Description Example
unifiedApi string ✔️ Unified API crm
serviceId string ✔️ Service ID of the resource to return pipedrive
consumerId ?string ➖ ID of the consumer which you want to get or push data from test-consumer
appId ?string ➖ The ID of your Unify application dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX

Response

?Operations\VaultCustomMappingsAllResponse

Errors

Error Type Status Code Content Type
Errors\BadRequestResponse 400 application/json
Errors\UnauthorizedResponse 401 application/json
Errors\PaymentRequiredResponse 402 application/json
Errors\NotFoundResponse 404 application/json
Errors\UnprocessableResponse 422 application/json
Errors\APIException 4XX, 5XX */*