The XMLHttpRequest method setRequestHeader() sets the value of an HTTP request header. When using setRequestHeader(), you must call it after calling open(), but before calling send(). If this method is called several times with the same header, the values are merged into one single request header.

Each time you call setRequestHeader() after the first time you call it, the specified text is appended to the end of the existing header's content.

If no Accept header has been set using this, an Accept header with the type "*/*" is sent with the request when send() is called.

For security reasons, some headers can only be controlled by the user agent. These headers include the forbidden header names  and forbidden response header names.

Note: For your custom fields, you may encounter "not allowed by Access-Control-Allow-Headers in preflight response" exception when you send request to cross domain. In this situation, you need set Access-Control-Allow-Headers in your response header at server side.

Syntax

XMLHttpRequest.setRequestHeader(header, value)

Parameters

header
The name of the header whose value is to be set.
value
The value to set as the body of the header.

Return value

undefined.

Specifications

Specification Status Comment
XMLHttpRequest
The definition of 'setRequestHeader()' in that specification.
Living Standard WHATWG living standard

Browser compatibility

FeatureChromeEdgeFirefoxInternet ExplorerOperaSafari
Basic support112 Yes

7

51

Yes1.2
FeatureAndroid webviewChrome for AndroidEdge mobileFirefox for AndroidOpera AndroidiOS SafariSamsung Internet
Basic support Yes1 Yes Yes Yes Yes Yes

1. Implemented via ActiveXObject

See also

Document Tags and Contributors

Last updated by: Sheppy,