vaultconnectionsettingsupdaterequest.md

VaultConnectionSettingsUpdateRequest

Example Usage

import { VaultConnectionSettingsUpdateRequest } from "@apideck/unify/models/operations";

let value: VaultConnectionSettingsUpdateRequest = {
  serviceId: "pipedrive",
  unifiedApi: "crm",
  resource: "leads",
  connection: {
    enabled: true,
    settings: {
      "instance_url": "https://eu28.salesforce.com",
      "api_key": "12345xxxxxx",
    },
    metadata: {
      "account": {
        "name": "My Company",
        "id": "c01458a5-7276-41ce-bc19-639906b0450a",
      },
      "plan": "enterprise",
    },
    configuration: [
      {
        resource: "leads",
        defaults: [
          {
            id: "ProductInterest",
            options: [
              {
                id: "1234",
                label: "General Channel",
                options: [
                  {
                    label: "General Channel",
                    value: 12.5,
                  },
                ],
              },
            ],
            value: true,
          },
        ],
      },
    ],
    customMappings: [
      {
        value: "$.root.training.first_aid",
      },
    ],
  },
};

Fields

Field	Type	Required	Description	Example
serviceId	string	✔️	Service ID of the resource to return	pipedrive
unifiedApi	string	✔️	Unified API	crm
resource	string	✔️	Name of the resource (plural)	leads
connection	components.ConnectionInput	✔️	Fields that need to be updated on the resource