afv-library/skills/platform-data-and-tooling-api-context-get/assets/enterprise_api/ChannelObjectLinkingRule.json

{
  "sections": [
    "title",
    "description",
    "fields",
    "field_reference"
  ],
  "title": "ChannelObjectLinkingRule - Data API",
  "description": "Represents a rule for linking a channel interaction with an object (such as Lead or Contact). This object is available in API version 47.0 and later.",
  "fields_columns": [
    "type",
    "properties",
    "description"
  ],
  "fields": {
    "ActionForNoRecordFound": {
      "type": "picklist",
      "properties": "Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update",
      "description": "Action to take when no matching records are found. Possible values are: CreateNewRecordAndLink—Create Record and Link (Recommended) PromptAgent—Prompt Agent"
    },
    "ActionForSingleRecordFound": {
      "type": "picklist",
      "properties": "Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update",
      "description": "Action to take when one matching record is found. Possible values are: AutoLink—Auto-Link Record (Recommended) PromptAgent—Prompt Agent"
    },
    "ChannelType": {
      "type": "picklist",
      "properties": "Create, Filter, Group, Restricted picklist, Sort",
      "description": "The type of channel used for this rule. Possible values are: FacebookMessenger Phone Text WeChat WhatsApp"
    },
    "Description": {
      "type": "textarea",
      "properties": "Create, Nillable, Update",
      "description": "The description for this linking rule."
    },
    "DeveloperName": {
      "type": "string",
      "properties": "Create, Filter, Group, Sort, Update",
      "description": "The unique name of the object in the API. This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. In managed packages, this field prevents naming conflicts on package installations. With this field, a developer can change the object’s name in a managed package and the changes are reflected in a subscriber’s organization. Note: When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance may slow while Salesforce generates one for each record. Note: Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field."
    },
    "IsLinkedRecordOpenedAsSubTab": {
      "type": "boolean",
      "properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
      "description": "Indicates whether to open the linked record as a subtab when the link is established."
    },
    "IsRuleActive": {
      "type": "boolean",
      "properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
      "description": "Indicates whether the rule is active."
    },
    "Language": {
      "type": "picklist",
      "properties": "Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update",
      "description": "The language for this linking rule. Possible values are: ar—Arabic bg—Bulgarian cs—Czech da—Danish de—German el—Greek en_GB—English (UK) en_US—English es—Spanish es_MX—Spanish (Mexico) fi—Finnish fr—French hr—Croatian hu—Hungarian in—Indonesian it—Italian iw—Hebrew ja—Japanese ko—Korean nl_NL—Dutch no—Norwegian pl—Polish pt_BR—Portuguese (Brazil) pt_PT—Portuguese (European) ro—Romanian ru—Russian sk—Slovak sl—Slovene sv—Swedish th—Thai tr—Turkish uk—Ukrainian vi—Vietnamese zh_CN—Chinese (Simplified) zh_TW—Chinese (Traditional)"
    },
    "MasterLabel": {
      "type": "string",
      "properties": "Create, Filter, Group, Sort, Update",
      "description": "The unique label name for this rule."
    },
    "ObjectToLink": {
      "type": "picklist",
      "properties": "Create, Filter, Group, Restricted picklist, Sort",
      "description": "The type of object to link to the channel interaction. Possible values are: Contact"
    },
    "RuleName": {
      "type": "string",
      "properties": "Create, Filter, Group, Sort, Update",
      "description": "Name of the rule as it appears in the UI. Maximum length is 80 characters."
    }
  },
  "field_reference": {
    "ActionForNoRecordFound": {
      "field_label": "Action For No Records Found",
      "type": "picklist",
      "length": "255"
    },
    "ActionForSingleRecordFound": {
      "field_label": "Action For Single Record Found",
      "type": "picklist",
      "length": "255"
    },
    "ChannelType": {
      "field_label": "Channel Type",
      "type": "picklist",
      "length": "255"
    },
    "CreatedById": {
      "field_label": "Created By ID",
      "type": "reference",
      "length": "18"
    },
    "CreatedDate": {
      "field_label": "Created Date",
      "type": "datetime"
    },
    "Description": {
      "field_label": "Description",
      "type": "textarea",
      "length": "4000"
    },
    "DeveloperName": {
      "field_label": "Name",
      "type": "string",
      "length": "80"
    },
    "Id": {
      "field_label": "Channel Object Linking Rule ID",
      "type": "id",
      "length": "18"
    },
    "IsDeleted": {
      "field_label": "Deleted",
      "type": "boolean"
    },
    "IsLinkedRecordOpenedAsSubTab": {
      "field_label": "Open Linked Record as a Subtab",
      "type": "boolean"
    },
    "IsRuleActive": {
      "field_label": "Active",
      "type": "boolean"
    },
    "Language": {
      "field_label": "Master Language",
      "type": "picklist",
      "length": "40"
    },
    "LastModifiedById": {
      "field_label": "Last Modified By ID",
      "type": "reference",
      "length": "18"
    },
    "LastModifiedDate": {
      "field_label": "Last Modified Date",
      "type": "datetime"
    },
    "MasterLabel": {
      "field_label": "Label",
      "type": "string",
      "length": "80"
    },
    "NamespacePrefix": {
      "field_label": "Namespace Prefix",
      "type": "string",
      "length": "15"
    },
    "ObjectToLink": {
      "field_label": "Object To Link",
      "type": "picklist",
      "length": "255"
    },
    "RuleName": {
      "field_label": "Name",
      "type": "string",
      "length": "255"
    },
    "SystemModstamp": {
      "field_label": "System Modstamp",
      "type": "datetime"
    }
  },
  "field_reference_columns": [
    "field_label",
    "type",
    "length"
  ]
}