Tableau Connector for Salesforce

Build 25.0.9434

CreateCustomField

Adds a new custom field to a specified Salesforce object.

Input

Name Type Description
Label String The user-facing label for the new custom field as it will appear in the Salesforce UI.
ObjectName String The API name of the Salesforce object (such as Account, Contact, or a custom object) to which the custom field will be added.
FieldName String The API name for the new custom field. This must be unique within the object and typically ends in '__c'.
Type String Data type of the custom field, such as Text, Number, Date, Picklist, or Checkbox.

The allowed values are Checkbox, Currency, Date, DateTime, Time, Email, Location, Number, Percent, Phone, Picklist, MultiselectPicklist, Text, TextArea, LongTextArea, Url, EncryptedText.

Description String Optional internal description of the custom field to help users and admins understand its purpose.
Required Boolean Indicates whether the field must have a value when a record is created or edited (true = required).
Unique Boolean Specifies whether the field must contain a unique value across all records in the object.
ExternalId Boolean Marks the field as an External ID, allowing it to be used for record matching in upserts and integrations.
DefaultValue String Specifies the default value that will populate the field when a new record is created, if no other value is provided.
Length Integer Maximum number of characters (for text fields) or digits (for numeric fields) that the field can contain.
Precision Integer Total number of digits allowed in the field, including digits to the left and right of the decimal point (for number fields).
Scale Integer Number of digits allowed after the decimal point in the field value (for number fields).
ValueSet String A comma-separated list of allowed values for picklist fields.
VisibleLines Integer Specifies the number of lines displayed in the UI for long text area fields.
MaskType String For encrypted text fields, defines how data is masked in the UI, such as 'all', 'last4', or 'none'.

The allowed values are all, creditCard, lastFour, nino, sin, ssn.

MaskChar String Character used to mask encrypted field values in the UI (such as '*').

The allowed values are asterisk, X.

Result Set Columns

Name Type Description
FullName String The full API name of the newly created custom field, including object prefix (for example, Account.CustomField__c).
Success String Indicates whether the custom field creation was successful (true) or not (false).

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9434