Skip to content

crmusersupdaterequest.md

Latest commit

 

History

History
93 lines (88 loc) · 7.58 KB

crmusersupdaterequest.md

File metadata and controls

93 lines (88 loc) · 7.58 KB

CrmUsersUpdateRequest

Example Usage

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

let value: CrmUsersUpdateRequest = {
  id: "<id>",
  serviceId: "salesforce",
  user: {
    parentId: "54321",
    username: "masterofcoin",
    firstName: "Elon",
    lastName: "Musk",
    title: "CEO",
    division: "Europe",
    companyName: "SpaceX",
    employeeNumber: "123456-AB",
    description: "A description",
    image: "https://logo.clearbit.com/spacex.com?s=128",
    language: "EN",
    status: "active",
    password: "supersecretpassword",
    addresses: [
      {
        id: "123",
        type: "primary",
        string: "25 Spring Street, Blackburn, VIC 3130",
        name: "HQ US",
        line1: "Main street",
        line2: "apt #",
        line3: "Suite #",
        line4: "delivery instructions",
        line5: "Attention: Finance Dept",
        streetNumber: "25",
        city: "San Francisco",
        state: "CA",
        postalCode: "94104",
        country: "US",
        latitude: "40.759211",
        longitude: "-73.984638",
        county: "Santa Clara",
        contactName: "Elon Musk",
        salutation: "Mr",
        phoneNumber: "111-111-1111",
        fax: "122-111-1111",
        email: "elon@musk.com",
        website: "https://elonmusk.com",
        notes: "Address notes or delivery instructions.",
        rowVersion: "1-12345",
      },
    ],
    phoneNumbers: [
      {
        id: "12345",
        countryCode: "1",
        areaCode: "323",
        number: "111-111-1111",
        extension: "105",
        type: "primary",
      },
    ],
    emails: [],
    passThrough: [
      {
        serviceId: "<id>",
        extendPaths: [
          {
            path: "$.nested.property",
            value: {
              "TaxClassificationRef": {
                "value": "EUC-99990201-V1-00020000",
              },
            },
          },
        ],
      },
    ],
  },
};

Fields

Field Type Required Description Example
id string ✔️ ID of the record you are acting upon.
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
serviceId string ➖ Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. salesforce
raw boolean ➖ Include raw response. Mostly used for debugging purposes
user components.UserInput ✔️ N/A