Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.
CloseFor some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.
Closename | The key of the header to be set. Case-sensitive. |
value | The header's intended value. |
Set a HTTP request header to a custom value.
Header keys and values must be valid according to HTTP protocol specification. Neither string may contain certain illegal characters, such as control characters. Both strings must be non-null and contain a minimum of 1 character. For more information, see HTTP specifications.
This method can't be called after SendWebRequest is called.
It is not recommended to set these headers to these custom values: Accept-Charset
, Accept-Encoding
, Access-Control-Request-Headers
, Access-Control-Request-Method
, Connection
, Date
, Dnt
, Expect
, Host
, Keep-Alive
, Origin
, Referer
, Te
, Trailer
, Transfer-Encoding
, Upgrade
, Via
. Due to different limitations across platforms, the custom value might be overridden, ignored, or unsupported, therefore the resulting behavior is unreliable.
It is strongly recommended to leave these headers for automatic handling unless you want to risk viewing any unexpected results.
The Accept-Encoding
header is automatically set to supported encodings. Use of a different value is ignored or might cause request to fail. For more information, refer to the [Mozilla docs](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Encoding) on Accept-Encoding.
The Content-Length
header is automatically populated based on the contents of the attached DownloadHandler if any, and can't be set to a custom value.
The X-Unity-Version
header is automatically set by Unity and might not be set to a custom value.
The User-Agent
header is automatically set by Unity and it's not recommended to set it to a custom value.
The Cookie
and Cookie2
headers are automatically managed by the underlying cookie engine. While the exact behavior is dependant on the platform used, typically, setting cookies via this header appends them to those set by engine. Additional resources: ClearCookieCache.
In addition, the following headers are filled by the Web browser on the Web platform, and therefore might not have any custom values set: Cookie
, Cookie2
, User-Agent
.
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.