---
schema_version: "1"
id: 96458aab4c9b00790b37e7440236a4e9333cf2ebce8eaef3754f7cf012347c76
title: CustomHttpHeader
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/object_reference/sforce_api_objects_customhttpheader.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_customhttpheader.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 5291c2fad8ff89bca9550542a437ef01d2f34dc108ba46051da59f59e81113a6
description: Represents a custom HTTP header that provides context information from Salesforce such as region, org details, or the role of the person viewing the external object. This object is available in API version 43.0 and later.
---
# CustomHttpHeader

Represents a custom HTTP header that provides context information from Salesforce such as region, org details, or the role of the person viewing the external object. This object is available in API version 43.0 and later.

## Supported Calls

describeLayout(), describeSObjects(), query(), retrieve()

## Special Access Rules

As of Spring ’20 and later, only authenticated internal and external users can access this object.

## Fields

| Field Name | Details |
| --- | --- |
| Description | 
Type

textarea

Properties

Filter, Nillable, Sort

Description

A text description of the header field’s purpose.



 |
| HeaderFieldName | 

Type

string

Properties

Filter, Group, Sort

Description

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



 |
| HeaderFieldValue | 

Type

string

Properties

Filter, Sort

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

Properties

Defaulted on create, Filter, Group, Sort

Description

Indicates whether the custom HTTP header is available to use.



 |
| ParentId | 

Type

reference

Properties

Filter, Group, Sort

Description

ID of the entity that the custom HTTP header is related to.

This is a polymorphic relationship field.

Relationship Name

Parent

Relationship Type

Lookup

Refers To

ExternalDataSource, NamedCredential



 |

## Usage

For each OData external data source, define up 10 HTTP headers to request data.

![Note](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png)

#### Note

HTTP headers aren’t supported on named credentials.