CustomHttpHeader

Represents a custom HTTP header used with OData 2.0 or OData 4.0 external data sources. Custom HTTP headers provide context information from Salesforce such as region, org details, or the role of the person viewing the external object.

Version 

Introduced in API version 51.0.

Supported SOAP API Calls 

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

Supported REST API Methods 

DELETE, GET, HEAD, PATCH, POST, Query

Fields 

Description 

• Type: textarea

• Required: No

• Properties: Create, Filter, Nillable, Sort, Update

• Description: A text description of the header field’s purpose.

HeaderFieldName 

• Type: string

• Required: No

• Properties: Create, Filter, Group, Sort, Update

• Description: Name of the header field. The name must contain at least one alphanumeric character or underscore. It can also include: ! # $ % & ’ * + - . ^ _ ` | ~

HeaderFieldValue 

• Type: string

• Required: No

• Properties: Create, Filter, Sort, Update

• Description: A formula that resolves to the value for the header. The values in the formula must evaluate to a string. If the formula resolves to null and an empty string, the header isn’t sent.

IsActive 

• Type: boolean

• Required: No

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

• Description: Indicates whether the custom HTTP header is available to use (true) or unavailable (false).

• Default value: false

ParentId 

• Type: reference

• Required: No

• Properties: Create, Filter, Group, Sort

• Description: ID of the entity to which this custom HTTP header is related.

• Relationship name: Parent

• Relationship type: polymorphic

• Refers to: ExternalDataSource, NamedCredential