---
schema_version: "1"
id: f23b81150dd1598e1de3e905d98c8b8b22078a9b85594692d8d95180e83cbe15
title: CustomHttpHeader
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_tooling/tooling_api_objects_customhttpheader.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_tooling.meta/api_tooling/tooling_api_objects_customhttpheader.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 2735f65662f4bca85a0521843f07d24818a9eb781f1b2926b40b4c067bf74de2
description: 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. This object is available in API version 51.0 and later.
---
# 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. This object is available in API version 51.0 and later.

## Supported SOAP API Calls

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

## Supported REST API Methods

DELETE, GET, HEAD, PATCH, POST, Query

## Fields

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

textarea

Properties

Create, Filter, Nillable, Sort, Update

Description

A text description of the header field’s purpose.



 |
| HeaderFieldName | 

Type

string

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

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

Properties

Create, Defaulted on create, Filter, Group, Sort, Update

Description

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



 |
| ParentId | 

Type

reference

Properties

Create, Filter, Group, Sort

Description

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



 |