CustomTab

Represents a custom tab.

Version 

Introduced in API version 33.0.

Supported SOAP API Calls 

create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()

Supported REST API Methods 

DELETE, GET, HEAD, PATCH, POST, Query

Fields 

ContentId 

• Type: reference

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: Read-only. The ID of the item that the custom tab points to. For Lightning components, this is the ID of the component bundle. For custom object tabs, this field is null.

• Relationship name: ContentId

• Relationship type: polymorphic

Description 

• Type: textarea

• Required: No

• Properties: Filter, Nillable, Sort

• Description: The tab’s description.

DeveloperName 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: The developer’s internal name for the custom tab.

EncodingKey 

• Type: picklist

• Required: No

• Properties: Filter, Group, Nillable, Restricted picklist, Sort

• Description: Read-only. Type of encoding assigned to the URL called by the tab. The default encoding setting is Unicode: UTF-8. Change it if you are passing information to a URL that requires data in a different format. This option is available when the value URL is selected in the tab type. Valid values are:

• UTF-8—Unicode (UTF-8)

• ISO-8859-1—General US & Western Europe (ISO-8859–1, ISO-LATIN-1)

• Shift_JIS—Japanese (Shift-JIS)

• ISO-2022-JP—Japanese (JIS)

• EUC-JP—Japanese (EUC-JP)

• x-SJIS_0213—Japanese (Shift-JIS_2004)

• ks_c_5601-1987—Korean (ks_c_5601-1987)

• Big5—Traditional Chinese (Big5)

• GB2312—Simplified Chinese (GB2312)

• Big5-HKSCS—Traditional Chinese Hong Kong (Big5–HKSCS)

• Possible values:

  • UTF-8 — Unicode (UTF-8)

  • ISO-8859-1 — General US & Western Europe (ISO-8859-1, ISO-LATIN-1)

  • Shift_JIS — Japanese (Shift-JIS)

  • ISO-2022-JP — Japanese (JIS)

  • EUC-JP — Japanese (EUC)

  • ks_c_5601-1987 — Korean (ks_c_5601-1987)

  • Big5 — Traditional Chinese (Big5)

  • GB2312 — Simplified Chinese (GB2312)

  • Big5-HKSCS — Traditional Chinese Hong Kong (Big5-HKSCS)

  • x-SJIS_0213 — Japanese (Shift-JIS_2004)

FullName 

• Type: string

• Required: No

• Properties: Create, Group, Nillable

• Description: The name of the tab. The value of this field depends on the type of tab, and the API version.

• For custom object tabs, the fullName is the developer-assigned name of the custom object (MyCustomObject__c, for example).

• For Web tabs, the fullName is the developer-assigned name of the tab (MyWebTab, for example).

Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance.

HasSidebar 

• Type: boolean

• Required: No

• Properties: Defaulted on create, Filter, Group, Sort

• Description: Indicates if the tab displays the sidebar panel.

• Default value: false

IconId 

• Type: reference

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Relationship name: IconId

• Relationship type: relationship

ManageableState 

• Type: picklist

• Required: No

• Properties: Filter, Group, Nillable, Restricted picklist, Sort

• Description: Indicates the manageable state of the specified component that is contained in a package:

• beta

• deleted

• deprecated

• deprecatedEditable

• installed

• installedEditable

• released

• unmanaged

• Possible values:

  • beta — beta

  • deleted — deleted

  • deprecated — deprecated

  • deprecatedEditable — deprecatedEditable

  • installed — installed

  • installedEditable — installedEditable

  • released — released

  • unmanaged — unmanaged

MasterLabel 

• Type: string

• Required: No

• Properties: Filter, Group, idLookup, Nillable, Sort

• Description: Required. The label for the custom tab, which displays in Setup.

Metadata 

• Type: complexvalue

• Required: No

• Properties: Create, Nillable, Update

• Description: Custom tab metadata.

Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance.

MotifName 

• Type: picklist

• Required: No

• Properties: Filter, Group, Restricted picklist, Sort

• Description: Read-only. The name of the tab style assigned to the custom tab.

• Possible values:

  • Custom1 — Heart

  • Custom2 — Fan

  • Custom3 — Sun

  • Custom4 — Hexagon

  • Custom5 — Leaf

  • Custom6 — Triangle

  • Custom7 — Square

  • Custom8 — Diamond

  • Custom9 — Lightning

  • Custom10 — Moon

  • Custom11 — Star

  • Custom12 — Circle

  • Custom13 — Box

  • Custom14 — Hands

  • Custom15 — People

  • Custom16 — Bank

  • Custom17 — Sack

  • Custom18 — Form

  • Custom19 — Wrench

  • Custom20 — Airplane

  • Custom21 — Computer

  • Custom22 — Phone

  • Custom23 — Mail

  • Custom24 — Building

  • Custom25 — Alarm clock

  • Custom26 — Flag

  • Custom27 — Laptop

  • Custom28 — Cell phone

  • Custom29 — PDA

  • Custom30 — Radar dish

  • Custom31 — Car

  • Custom32 — Factory

  • Custom33 — Desk

  • Custom34 — Insect

  • Custom35 — Microphone

  • Custom36 — Train

  • Custom37 — Bridge

  • Custom38 — Camera

  • Custom39 — Telescope

  • Custom40 — Credit card

  • Custom41 — Stack of Cash

  • Custom42 — Treasure chest

  • Custom43 — Jewel

  • Custom44 — Hammer

  • Custom45 — Ticket

  • Custom46 — Postage

  • Custom47 — Chess piece

  • Custom48 — Trophy

  • Custom49 — CD/DVD

  • Custom50 — Big top

  • Custom51 — Apple

  • Custom52 — Balls

  • Custom53 — Bell

  • Custom54 — Boat

  • Custom55 — Books

  • Custom56 — Bottle

  • Custom57 — Building Block

  • Custom58 — Caduceus

  • Custom59 — Can

  • Custom60 — Umbrella

  • Custom61 — Castle

  • Custom62 — Chalkboard

  • Custom63 — Chip

  • Custom64 — Compass

  • Custom65 — Cup

  • Custom66 — Dice

  • Custom67 — Gears

  • Custom68 — Globe

  • Custom69 — Guitar

  • Custom70 — Handsaw

  • Custom71 — Headset

  • Custom72 — Helicopter

  • Custom73 — Highway Sign

  • Custom74 — Hot Air Balloon

  • Custom75 — IP Phone

  • Custom76 — Keys

  • Custom77 — Locked

  • Custom78 — Map

  • Custom79 — Measuring Tape

  • Custom80 — Motorcycle

  • Custom81 — Musical Note

  • Custom82 — Whistle

  • Custom83 — Pencil

  • Custom84 — Presenter

  • Custom85 — Real Estate Sign

  • Custom86 — Red Cross

  • Custom87 — Safe

  • Custom88 — Sailboat

  • Custom89 — Saxophone

  • Custom90 — Scales

  • Custom91 — Shield

  • Custom92 — Ship

  • Custom93 — Shopping Cart

  • Custom94 — Stethoscope

  • Custom95 — Stopwatch

  • Custom96 — Street Sign

  • Custom97 — Thermometer

  • Custom98 — Truck

  • Custom99 — CRT TV

  • Custom100 — TV Widescreen

  • Custom101 — TV Widescreen

  • Custom102 — TV Widescreen

  • Custom103 — TV Widescreen

  • Custom104 — TV Widescreen

  • Custom105 — TV Widescreen

  • Custom106 — TV Widescreen

  • Custom107 — TV Widescreen

  • Custom108 — TV Widescreen

  • Custom109 — TV Widescreen

  • Custom110 — TV Widescreen

  • Custom111 — TV Widescreen

  • Custom112 — TV Widescreen

  • Custom113 — TV Widescreen

  • Custom114 — TV Widescreen

  • Custom115 — TV Widescreen

  • Custom116 — TV Widescreen

  • Custom117 — TV Widescreen

  • Custom118 — TV Widescreen

  • Custom119 — TV Widescreen

  • Custom120 — TV Widescreen

  • Custom121 — TV Widescreen

  • Custom122 — TV Widescreen

  • Custom123 — TV Widescreen

  • Custom124 — TV Widescreen

  • Custom125 — TV Widescreen

  • Custom126 — TV Widescreen

  • Custom127 — TV Widescreen

  • Custom128 — TV Widescreen

  • Custom129 — TV Widescreen

  • Custom130 — TV Widescreen

  • Custom131 — TV Widescreen

  • Custom132 — TV Widescreen

  • Custom133 — TV Widescreen

  • Custom134 — TV Widescreen

  • Custom135 — TV Widescreen

  • Custom136 — TV Widescreen

  • Custom137 — TV Widescreen

  • Custom138 — TV Widescreen

  • Custom139 — TV Widescreen

  • Custom140 — TV Widescreen

  • Custom141 — TV Widescreen

  • Custom142 — TV Widescreen

  • Custom143 — TV Widescreen

  • Custom144 — TV Widescreen

  • Custom145 — TV Widescreen

  • Custom146 — TV Widescreen

  • Custom147 — TV Widescreen

  • Custom148 — TV Widescreen

  • Custom149 — TV Widescreen

  • Custom150 — TV Widescreen

  • Custom151 — TV Widescreen

  • Custom152 — TV Widescreen

  • Custom153 — TV Widescreen

  • Custom154 — TV Widescreen

  • Custom155 — TV Widescreen

  • Custom156 — TV Widescreen

  • Custom157 — TV Widescreen

  • Custom158 — TV Widescreen

  • Custom159 — TV Widescreen

  • Custom160 — TV Widescreen

  • Custom161 — TV Widescreen

  • Custom162 — TV Widescreen

  • Custom163 — TV Widescreen

  • Custom164 — TV Widescreen

  • Custom165 — TV Widescreen

  • Custom166 — TV Widescreen

  • Custom167 — TV Widescreen

  • Custom168 — TV Widescreen

  • Custom169 — TV Widescreen

  • Custom170 — TV Widescreen

  • Custom171 — TV Widescreen

  • Custom172 — TV Widescreen

  • Custom173 — TV Widescreen

  • Custom174 — TV Widescreen

  • Custom175 — TV Widescreen

  • Custom176 — TV Widescreen

  • Custom177 — TV Widescreen

  • Custom178 — TV Widescreen

  • Custom179 — TV Widescreen

  • Custom180 — TV Widescreen

  • Custom181 — TV Widescreen

  • Custom182 — TV Widescreen

  • Custom183 — TV Widescreen

  • Custom184 — TV Widescreen

  • Custom185 — TV Widescreen

  • Custom186 — TV Widescreen

  • Custom187 — TV Widescreen

  • Custom188 — TV Widescreen

  • Custom189 — TV Widescreen

  • Custom190 — TV Widescreen

  • Custom191 — TV Widescreen

  • Custom192 — TV Widescreen

  • Custom193 — TV Widescreen

  • Custom194 — TV Widescreen

  • Custom195 — TV Widescreen

  • Custom196 — TV Widescreen

  • Custom197 — TV Widescreen

  • Custom198 — TV Widescreen

  • Custom199 — TV Widescreen

  • Custom200 — TV Widescreen

  • Custom201 — TV Widescreen

  • Custom202 — TV Widescreen

  • Custom203 — TV Widescreen

  • Custom204 — TV Widescreen

  • Custom205 — TV Widescreen

  • Custom206 — TV Widescreen

  • Custom207 — TV Widescreen

  • Custom208 — TV Widescreen

  • Custom209 — TV Widescreen

  • Custom210 — TV Widescreen

  • Custom211 — TV Widescreen

  • Custom212 — TV Widescreen

  • Custom213 — TV Widescreen

  • Custom214 — TV Widescreen

  • Custom215 — TV Widescreen

  • Custom216 — TV Widescreen

  • Custom217 — TV Widescreen

  • Custom218 — TV Widescreen

  • Custom219 — TV Widescreen

  • Custom220 — TV Widescreen

  • Custom221 — TV Widescreen

  • Custom222 — TV Widescreen

  • Custom223 — TV Widescreen

  • Custom224 — TV Widescreen

  • Custom225 — TV Widescreen

  • Custom226 — TV Widescreen

  • Custom227 — TV Widescreen

  • Custom228 — TV Widescreen

  • Custom229 — TV Widescreen

  • Custom230 — TV Widescreen

  • Custom231 — TV Widescreen

  • Custom232 — TV Widescreen

  • Custom233 — TV Widescreen

  • Custom234 — TV Widescreen

  • Custom235 — TV Widescreen

  • Custom236 — TV Widescreen

  • Custom237 — TV Widescreen

  • Custom238 — TV Widescreen

  • Custom239 — TV Widescreen

  • Custom240 — TV Widescreen

  • Custom241 — TV Widescreen

  • Custom242 — TV Widescreen

  • Custom243 — TV Widescreen

  • Custom244 — TV Widescreen

  • Custom245 — TV Widescreen

  • Custom246 — TV Widescreen

  • Custom247 — TV Widescreen

  • Custom248 — TV Widescreen

  • Custom249 — TV Widescreen

  • Custom250 — TV Widescreen

  • Custom251 — TV Widescreen

  • Custom252 — TV Widescreen

  • Custom253 — TV Widescreen

  • Custom254 — TV Widescreen

  • Custom255 — TV Widescreen

  • Custom256 — TV Widescreen

  • Custom257 — TV Widescreen

  • Custom258 — TV Widescreen

  • Custom259 — TV Widescreen

  • Custom260 — TV Widescreen

  • Custom261 — TV Widescreen

  • Custom262 — TV Widescreen

  • Custom263 — TV Widescreen

  • Custom264 — TV Widescreen

  • Custom265 — TV Widescreen

  • Custom266 — TV Widescreen

  • Custom267 — TV Widescreen

  • Custom268 — TV Widescreen

  • Custom269 — TV Widescreen

  • Custom270 — TV Widescreen

  • Custom271 — TV Widescreen

  • Custom272 — TV Widescreen

  • Custom273 — TV Widescreen

  • Custom274 — TV Widescreen

  • Custom275 — TV Widescreen

  • Custom276 — TV Widescreen

  • Custom277 — TV Widescreen

  • Custom278 — TV Widescreen

  • Custom279 — TV Widescreen

  • Custom280 — TV Widescreen

  • Custom281 — TV Widescreen

  • Custom282 — TV Widescreen

  • Custom283 — TV Widescreen

  • Custom284 — TV Widescreen

  • Custom285 — TV Widescreen

  • Custom286 — TV Widescreen

  • Custom287 — TV Widescreen

  • Custom288 — TV Widescreen

  • Custom289 — TV Widescreen

  • Custom290 — TV Widescreen

  • Custom291 — TV Widescreen

  • Custom292 — TV Widescreen

  • Custom293 — TV Widescreen

  • Custom294 — TV Widescreen

  • Custom295 — TV Widescreen

  • Custom296 — TV Widescreen

  • Custom297 — TV Widescreen

  • Custom298 — TV Widescreen

  • Custom299 — TV Widescreen

  • Custom300 — TV Widescreen

  • Custom301 — TV Widescreen

  • Custom302 — TV Widescreen

  • Custom303 — TV Widescreen

  • Custom304 — TV Widescreen

  • Custom305 — TV Widescreen

  • Custom306 — TV Widescreen

  • Custom307 — TV Widescreen

  • Custom308 — TV Widescreen

  • Custom309 — TV Widescreen

  • Custom310 — TV Widescreen

  • Custom311 — TV Widescreen

  • Custom312 — TV Widescreen

  • Custom313 — TV Widescreen

  • Custom314 — TV Widescreen

  • Custom315 — TV Widescreen

  • Custom316 — TV Widescreen

  • Custom317 — TV Widescreen

  • Custom318 — TV Widescreen

  • Custom319 — TV Widescreen

  • Custom320 — TV Widescreen

  • Custom321 — TV Widescreen

  • Custom322 — TV Widescreen

  • Custom323 — TV Widescreen

  • Custom324 — TV Widescreen

  • Custom325 — TV Widescreen

  • Custom326 — TV Widescreen

  • Custom327 — TV Widescreen

  • Custom328 — TV Widescreen

  • Custom329 — TV Widescreen

  • Custom330 — TV Widescreen

  • Custom331 — TV Widescreen

  • Custom332 — TV Widescreen

  • Custom333 — TV Widescreen

  • Custom334 — TV Widescreen

  • Custom335 — TV Widescreen

  • Custom336 — TV Widescreen

  • Custom337 — TV Widescreen

  • Custom338 — TV Widescreen

  • Custom339 — TV Widescreen

  • Custom340 — TV Widescreen

  • Custom341 — TV Widescreen

  • Custom342 — TV Widescreen

  • Custom343 — TV Widescreen

  • Custom344 — TV Widescreen

  • Custom345 — TV Widescreen

  • Custom346 — TV Widescreen

  • Custom347 — TV Widescreen

  • Custom348 — TV Widescreen

  • Custom349 — TV Widescreen

  • Custom350 — TV Widescreen

  • Custom351 — TV Widescreen

  • Custom352 — TV Widescreen

  • Custom353 — TV Widescreen

  • Custom354 — TV Widescreen

  • Custom355 — TV Widescreen

  • Custom356 — TV Widescreen

NamespacePrefix 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: The namespace of the package of which the custom tab is a part.

Type 

• Type: picklist

• Required: No

• Properties: Filter, Group, Restricted picklist, Sort

• Description: The type of custom tab.

• Possible values:

  • customObject — Custom Object

  • url — URL

  • sControl — Custom S-Control

  • apexPage — Visualforce Page

  • flexiPage — Lightning Page

  • aura — Lightning Component

Url 

• Type: url

• Required: No

• Properties: Filter, Nillable, Sort

• Description: The URL for the external web-page to embed in this tab.