Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

Post

Creates a UnityWebRequest configured to send form data to a server via HTTP POST.
Read time 17 minutesLast updated 6 days ago

Definition

Post(string, string, string)

Creates a UnityWebRequest configured to send form data to a server via HTTP 
POST
.
public static UnityWebRequest Post(string uri, string postData, string contentType)

Parameters

uri

string
The target URI to which the string will be transmitted.

postData

string
Form body data. Will be converted to UTF-8 string.

contentType

string
Value for the Content-Type header, for example application/json.

Returns

Type

Description

UnityWebRequestA UnityWebRequest configured to send string to 
uri
via 
POST
.

Remarks

This method creates a UnityWebRequest, sets the 
url
to the string 
uri
argument and sets the 
method
to 
POST
. The 
Content-Type
header will be set to 
contentType
.
This method attaches a DownloadHandlerBuffer to the UnityWebRequest. This is for convenience, as we anticipate most users will use the DownloadHandler to check replies from the server, particularly in the case of REST APIs.
The data in 
postData
will be interpreted into a byte stream via System.Text.Encoding.UTF8. The resulting byte stream will be stored in an UploadHandlerRaw and the Upload Handler will be attached to this UnityWebRequest.

Examples

using UnityEngine;using UnityEngine.Networking;using System.Collections;public class MyBehavior : MonoBehaviour{    void Start()    {        StartCoroutine(Upload());    }    IEnumerator Upload()    {        using (UnityWebRequest www = UnityWebRequest.Post("https://www.my-server.com/myapi", "{ \"field1\": 1, \"field2\": 2 }", "application/json"))        {            yield return www.SendWebRequest();            if (www.result != UnityWebRequest.Result.Success)            {                Debug.LogError(www.error);            }            else            {                Debug.Log("Form upload complete!");            }        }    }}

Post(Uri, string, string)

Creates a UnityWebRequest configured to send form data to a server via HTTP 
POST
.
public static UnityWebRequest Post(Uri uri, string postData, string contentType)

Parameters

uri

Uri
The target URI to which the string will be transmitted.

postData

string
Form body data. Will be converted to UTF-8 string.

contentType

string
Value for the Content-Type header, for example application/json.

Returns

Type

Description

UnityWebRequestA UnityWebRequest configured to send string to 
uri
via 
POST
.

Remarks

This method creates a UnityWebRequest, sets the 
url
to the string 
uri
argument and sets the 
method
to 
POST
. The 
Content-Type
header will be set to 
contentType
.
This method attaches a DownloadHandlerBuffer to the UnityWebRequest. This is for convenience, as we anticipate most users will use the DownloadHandler to check replies from the server, particularly in the case of REST APIs.
The data in 
postData
will be interpreted into a byte stream via System.Text.Encoding.UTF8. The resulting byte stream will be stored in an UploadHandlerRaw and the Upload Handler will be attached to this UnityWebRequest.

Examples

using UnityEngine;using UnityEngine.Networking;using System.Collections;public class MyBehavior : MonoBehaviour{    void Start()    {        StartCoroutine(Upload());    }    IEnumerator Upload()    {        using (UnityWebRequest www = UnityWebRequest.Post("https://www.my-server.com/myapi", "{ \"field1\": 1, \"field2\": 2 }", "application/json"))        {            yield return www.SendWebRequest();            if (www.result != UnityWebRequest.Result.Success)            {                Debug.LogError(www.error);            }            else            {                Debug.Log("Form upload complete!");            }        }    }}

Post(string, WWWForm)

Create a UnityWebRequest configured to send form data to a server via HTTP 
POST
.
public static UnityWebRequest Post(string uri, WWWForm formData)

Parameters

uri

string
The target URI to which form data will be transmitted.

formData

WWWForm
Form fields or files encapsulated in a WWWForm object, for formatting and transmission to the remote server.

Returns

Type

Description

UnityWebRequestA UnityWebRequest configured to send form data to 
uri
via 
POST
.

Remarks

This method creates a UnityWebRequest, sets the 
url
to the string 
uri
argument and sets the 
method
to 
POST
. The 
Content-Type
header will be copied from the 
formData
parameter.
This method attaches a DownloadHandlerBuffer to the UnityWebRequest. This is for convenience, as we anticipate most users will use the DownloadHandler to check replies from the server, particularly in the case of REST APIs.
The 
formData
object will generate an appropriately-formatted byte stream, depending on its contents. The resulting byte stream will be stored in an UploadHandlerRaw and the Upload Handler will be attached to this UnityWebRequest.

Examples

using UnityEngine;using UnityEngine.Networking;using System.Collections;public class MyBehavior2 : MonoBehaviour{    void Start()    {        StartCoroutine(Upload());    }    IEnumerator Upload()    {        WWWForm form = new WWWForm();        form.AddField("myField", "myData");        using UnityWebRequest www = UnityWebRequest.Post("https://www.my-server.com/myform", form);        yield return www.SendWebRequest();        if (www.result != UnityWebRequest.Result.Success)        {            Debug.LogError(www.error);        }        else        {            Debug.Log("Form upload complete!");        }    }}

Post(Uri, WWWForm)

Create a UnityWebRequest configured to send form data to a server via HTTP 
POST
.
public static UnityWebRequest Post(Uri uri, WWWForm formData)

Parameters

uri

Uri
The target URI to which form data will be transmitted.

formData

WWWForm
Form fields or files encapsulated in a WWWForm object, for formatting and transmission to the remote server.

Returns

Type

Description

UnityWebRequestA UnityWebRequest configured to send form data to 
uri
via 
POST
.

Remarks

This method creates a UnityWebRequest, sets the 
url
to the string 
uri
argument and sets the 
method
to 
POST
. The 
Content-Type
header will be copied from the 
formData
parameter.
This method attaches a DownloadHandlerBuffer to the UnityWebRequest. This is for convenience, as we anticipate most users will use the DownloadHandler to check replies from the server, particularly in the case of REST APIs.
The 
formData
object will generate an appropriately-formatted byte stream, depending on its contents. The resulting byte stream will be stored in an UploadHandlerRaw and the Upload Handler will be attached to this UnityWebRequest.

Examples

using UnityEngine;using UnityEngine.Networking;using System.Collections;public class MyBehavior2 : MonoBehaviour{    void Start()    {        StartCoroutine(Upload());    }    IEnumerator Upload()    {        WWWForm form = new WWWForm();        form.AddField("myField", "myData");        using UnityWebRequest www = UnityWebRequest.Post("https://www.my-server.com/myform", form);        yield return www.SendWebRequest();        if (www.result != UnityWebRequest.Result.Success)        {            Debug.LogError(www.error);        }        else        {            Debug.Log("Form upload complete!");        }    }}

Post(string, List<IMultipartFormSection>)

Create a UnityWebRequest configured to send form data to a server via HTTP 
POST
.
public static UnityWebRequest Post(string uri, List<IMultipartFormSection> multipartFormSections)

Parameters

uri

string
The target URI to which form data will be transmitted.

multipartFormSections

List<IMultipartFormSection>
A list of form fields or files to be formatted and transmitted to the remote server.

Returns

Type

Description

UnityWebRequestA UnityWebRequest configured to send form data to 
uri
via 
POST
.

Remarks

This method creates a UnityWebRequest, sets the 
url
to the string 
uri
argument and sets the 
method
to 
POST
. The 
Content-Type
header will be set to 
multipart/form-data
, with an appropriate boundary specification.
If you supply a custom 
boundary
byte array, note that the sequence of bytes must be guaranteed to be unique and must not appear anywhere in the body of your form data. For more information on multipart forms and form boundaries, see RFC 2388.
This method attaches a DownloadHandlerBuffer to the UnityWebRequest. This is for convenience, as we anticipate most users will use the DownloadHandler to check replies from the server, particularly in the case of REST APIs.
The List of IMultipartFormSection objects in 
multipartFormSections
will be formatted into a valid multipart form body. Each object will be interpreted as a discrete form section. The byte stream resulting from formatting this multipart form body will be stored in an UploadHandlerRaw and attached to this UnityWebRequest.
Using IMultipartFormSection
To provide greater control over how you specify your form data, the UnityWebRequest system contains a (user-implementable) IMultipartFormSection interface. For standard applications, Unity also provides default implementations for data and file sections.
Additional Resources: MultipartFormDataSection and MultipartFormFileSection.
A List of IMultipartFormSection objects can be provided to this method. The list's members will be formatted into a multipart form, as defined by RFC 2388.
Multipart forms require a unique boundary string to define the separation between fields. The boundary string must be guaranteed to not be present anywhere within the body of any form field in the request. If you do not supply a boundary, Unity will generate one. The generated boundary is 40 random printable bytes, which effectively never collide with form field data. However, if your application requires you to supply a custom boundary string, you may do so.
The supplied boundary, if any, will be automatically converted from a byte array to UTF8 characters.

Examples

using UnityEngine;using UnityEngine.Networking;using System.Collections;using System.Collections.Generic;public class MyBehavior3 : MonoBehaviour{    void Start()    {        StartCoroutine(Upload());    }    IEnumerator Upload()    {        List<IMultipartFormSection> form = new();        form.Add(new MultipartFormDataSection("myField", "myData"));        using UnityWebRequest www = UnityWebRequest.Post("https://httpbin.org/post", form);        yield return www.SendWebRequest();        if (www.result != UnityWebRequest.Result.Success)        {            Debug.LogError(www.error);        }        else        {            Debug.Log("Form upload complete!");        }    }}

Post(Uri, List<IMultipartFormSection>)

Create a UnityWebRequest configured to send form data to a server via HTTP 
POST
.
public static UnityWebRequest Post(Uri uri, List<IMultipartFormSection> multipartFormSections)

Parameters

uri

Uri
The target URI to which form data will be transmitted.

multipartFormSections

List<IMultipartFormSection>
A list of form fields or files to be formatted and transmitted to the remote server.

Returns

Type

Description

UnityWebRequestA UnityWebRequest configured to send form data to 
uri
via 
POST
.

Remarks

This method creates a UnityWebRequest, sets the 
url
to the string 
uri
argument and sets the 
method
to 
POST
. The 
Content-Type
header will be set to 
multipart/form-data
, with an appropriate boundary specification.
If you supply a custom 
boundary
byte array, note that the sequence of bytes must be guaranteed to be unique and must not appear anywhere in the body of your form data. For more information on multipart forms and form boundaries, see RFC 2388.
This method attaches a DownloadHandlerBuffer to the UnityWebRequest. This is for convenience, as we anticipate most users will use the DownloadHandler to check replies from the server, particularly in the case of REST APIs.
The List of IMultipartFormSection objects in 
multipartFormSections
will be formatted into a valid multipart form body. Each object will be interpreted as a discrete form section. The byte stream resulting from formatting this multipart form body will be stored in an UploadHandlerRaw and attached to this UnityWebRequest.
Using IMultipartFormSection
To provide greater control over how you specify your form data, the UnityWebRequest system contains a (user-implementable) IMultipartFormSection interface. For standard applications, Unity also provides default implementations for data and file sections.
Additional Resources: MultipartFormDataSection and MultipartFormFileSection.
A List of IMultipartFormSection objects can be provided to this method. The list's members will be formatted into a multipart form, as defined by RFC 2388.
Multipart forms require a unique boundary string to define the separation between fields. The boundary string must be guaranteed to not be present anywhere within the body of any form field in the request. If you do not supply a boundary, Unity will generate one. The generated boundary is 40 random printable bytes, which effectively never collide with form field data. However, if your application requires you to supply a custom boundary string, you may do so.
The supplied boundary, if any, will be automatically converted from a byte array to UTF8 characters.

Examples

using UnityEngine;using UnityEngine.Networking;using System.Collections;using System.Collections.Generic;public class MyBehavior3 : MonoBehaviour{    void Start()    {        StartCoroutine(Upload());    }    IEnumerator Upload()    {        List<IMultipartFormSection> form = new();        form.Add(new MultipartFormDataSection("myField", "myData"));        using UnityWebRequest www = UnityWebRequest.Post("https://httpbin.org/post", form);        yield return www.SendWebRequest();        if (www.result != UnityWebRequest.Result.Success)        {            Debug.LogError(www.error);        }        else        {            Debug.Log("Form upload complete!");        }    }}

Post(string, List<IMultipartFormSection>, byte[])

Create a UnityWebRequest configured to send form data to a server via HTTP 
POST
.
public static UnityWebRequest Post(string uri, List<IMultipartFormSection> multipartFormSections, byte[] boundary)

Parameters

uri

string
The target URI to which form data will be transmitted.

multipartFormSections

List<IMultipartFormSection>
A list of form fields or files to be formatted and transmitted to the remote server.

boundary

byte[]
A unique boundary string, which will be used when separating form fields in a multipart form. If not supplied, a boundary will be generated for you.

Returns

Type

Description

UnityWebRequestA UnityWebRequest configured to send form data to 
uri
via 
POST
.

Remarks

This method creates a UnityWebRequest, sets the 
url
to the string 
uri
argument and sets the 
method
to 
POST
. The 
Content-Type
header will be set to 
multipart/form-data
, with an appropriate boundary specification.
If you supply a custom 
boundary
byte array, note that the sequence of bytes must be guaranteed to be unique and must not appear anywhere in the body of your form data. For more information on multipart forms and form boundaries, see RFC 2388.
This method attaches a DownloadHandlerBuffer to the UnityWebRequest. This is for convenience, as we anticipate most users will use the DownloadHandler to check replies from the server, particularly in the case of REST APIs.
The List of IMultipartFormSection objects in 
multipartFormSections
will be formatted into a valid multipart form body. Each object will be interpreted as a discrete form section. The byte stream resulting from formatting this multipart form body will be stored in an UploadHandlerRaw and attached to this UnityWebRequest.
Using IMultipartFormSection
To provide greater control over how you specify your form data, the UnityWebRequest system contains a (user-implementable) IMultipartFormSection interface. For standard applications, Unity also provides default implementations for data and file sections.
Additional Resources: MultipartFormDataSection and MultipartFormFileSection.
A List of IMultipartFormSection objects can be provided to this method. The list's members will be formatted into a multipart form, as defined by RFC 2388.
Multipart forms require a unique boundary string to define the separation between fields. The boundary string must be guaranteed to not be present anywhere within the body of any form field in the request. If you do not supply a boundary, Unity will generate one. The generated boundary is 40 random printable bytes, which effectively never collide with form field data. However, if your application requires you to supply a custom boundary string, you may do so.
The supplied boundary, if any, will be automatically converted from a byte array to UTF8 characters.

Examples

using UnityEngine;using UnityEngine.Networking;using System.Collections;using System.Collections.Generic;public class MyBehavior3 : MonoBehaviour{    void Start()    {        StartCoroutine(Upload());    }    IEnumerator Upload()    {        List<IMultipartFormSection> form = new();        form.Add(new MultipartFormDataSection("myField", "myData"));        using UnityWebRequest www = UnityWebRequest.Post("https://httpbin.org/post", form);        yield return www.SendWebRequest();        if (www.result != UnityWebRequest.Result.Success)        {            Debug.LogError(www.error);        }        else        {            Debug.Log("Form upload complete!");        }    }}

Post(Uri, List<IMultipartFormSection>, byte[])

Create a UnityWebRequest configured to send form data to a server via HTTP 
POST
.
public static UnityWebRequest Post(Uri uri, List<IMultipartFormSection> multipartFormSections, byte[] boundary)

Parameters

uri

Uri
The target URI to which form data will be transmitted.

multipartFormSections

List<IMultipartFormSection>
A list of form fields or files to be formatted and transmitted to the remote server.

boundary

byte[]
A unique boundary string, which will be used when separating form fields in a multipart form. If not supplied, a boundary will be generated for you.

Returns

Type

Description

UnityWebRequestA UnityWebRequest configured to send form data to 
uri
via 
POST
.

Remarks

This method creates a UnityWebRequest, sets the 
url
to the string 
uri
argument and sets the 
method
to 
POST
. The 
Content-Type
header will be set to 
multipart/form-data
, with an appropriate boundary specification.
If you supply a custom 
boundary
byte array, note that the sequence of bytes must be guaranteed to be unique and must not appear anywhere in the body of your form data. For more information on multipart forms and form boundaries, see RFC 2388.
This method attaches a DownloadHandlerBuffer to the UnityWebRequest. This is for convenience, as we anticipate most users will use the DownloadHandler to check replies from the server, particularly in the case of REST APIs.
The List of IMultipartFormSection objects in 
multipartFormSections
will be formatted into a valid multipart form body. Each object will be interpreted as a discrete form section. The byte stream resulting from formatting this multipart form body will be stored in an UploadHandlerRaw and attached to this UnityWebRequest.
Using IMultipartFormSection
To provide greater control over how you specify your form data, the UnityWebRequest system contains a (user-implementable) IMultipartFormSection interface. For standard applications, Unity also provides default implementations for data and file sections.
Additional Resources: MultipartFormDataSection and MultipartFormFileSection.
A List of IMultipartFormSection objects can be provided to this method. The list's members will be formatted into a multipart form, as defined by RFC 2388.
Multipart forms require a unique boundary string to define the separation between fields. The boundary string must be guaranteed to not be present anywhere within the body of any form field in the request. If you do not supply a boundary, Unity will generate one. The generated boundary is 40 random printable bytes, which effectively never collide with form field data. However, if your application requires you to supply a custom boundary string, you may do so.
The supplied boundary, if any, will be automatically converted from a byte array to UTF8 characters.

Examples

using UnityEngine;using UnityEngine.Networking;using System.Collections;using System.Collections.Generic;public class MyBehavior3 : MonoBehaviour{    void Start()    {        StartCoroutine(Upload());    }    IEnumerator Upload()    {        List<IMultipartFormSection> form = new();        form.Add(new MultipartFormDataSection("myField", "myData"));        using UnityWebRequest www = UnityWebRequest.Post("https://httpbin.org/post", form);        yield return www.SendWebRequest();        if (www.result != UnityWebRequest.Result.Success)        {            Debug.LogError(www.error);        }        else        {            Debug.Log("Form upload complete!");        }    }}

Post(string, Dictionary<string, string>)

Create a UnityWebRequest configured to send form data to a server via HTTP 
POST
.
public static UnityWebRequest Post(string uri, Dictionary<string, string> formFields)

Parameters

uri

string
The target URI to which form data will be transmitted.

formFields

Dictionary<string, string>
Strings indicating the keys and values of form fields. Will be automatically formatted into a URL-encoded form body.

Returns

Type

Description

UnityWebRequestA UnityWebRequest configured to send form data to 
uri
via 
POST
.

Remarks

This method creates a UnityWebRequest, sets the 
url
to the string 
uri
argument and sets the 
method
to 
POST
. The 
Content-Type
header will be set to 
application/x-www-form-urlencoded
.
The Dictionary of strings in 
formFields
will be interpreted as a list of form fields whose field IDs are the dictionary keys, and whose field values are the dictionary values. Both keys and values will be escaped, and then joined into a URL-encoded form string. (for example, 
key1=value1&key2=value2
).
This method, by default, attaches a DownloadHandlerBuffer to the UnityWebRequest. This is for convenience, as we anticipate most users will use the DownloadHandler to check replies from the server, particularly in the case of REST APIs.
The URL-encoded form string generated from 
formFields
will be converted into a byte stream and stored in an UploadHandlerRaw, which will be attached to this UnityWebRequest.

Examples

using UnityEngine;using UnityEngine.Networking;using System.Collections;using System.Collections.Generic;public class MyBehavior4 : MonoBehaviour{    void Start()    {        StartCoroutine(Upload());    }    IEnumerator Upload()    {        Dictionary<string, string> form = new();        form["myField"] = "myData";        using UnityWebRequest www = UnityWebRequest.Post("https://httpbin.org/post", form);        yield return www.SendWebRequest();        if (www.result != UnityWebRequest.Result.Success)        {            Debug.LogError(www.error);        }        else        {            Debug.Log("Form upload complete!");        }    }}

Post(Uri, Dictionary<string, string>)

Create a UnityWebRequest configured to send form data to a server via HTTP 
POST
.
public static UnityWebRequest Post(Uri uri, Dictionary<string, string> formFields)

Parameters

uri

Uri
The target URI to which form data will be transmitted.

formFields

Dictionary<string, string>
Strings indicating the keys and values of form fields. Will be automatically formatted into a URL-encoded form body.

Returns

Type

Description

UnityWebRequestA UnityWebRequest configured to send form data to 
uri
via 
POST
.

Remarks

This method creates a UnityWebRequest, sets the 
url
to the string 
uri
argument and sets the 
method
to 
POST
. The 
Content-Type
header will be set to 
application/x-www-form-urlencoded
.
The Dictionary of strings in 
formFields
will be interpreted as a list of form fields whose field IDs are the dictionary keys, and whose field values are the dictionary values. Both keys and values will be escaped, and then joined into a URL-encoded form string. (for example, 
key1=value1&key2=value2
).
This method, by default, attaches a DownloadHandlerBuffer to the UnityWebRequest. This is for convenience, as we anticipate most users will use the DownloadHandler to check replies from the server, particularly in the case of REST APIs.
The URL-encoded form string generated from 
formFields
will be converted into a byte stream and stored in an UploadHandlerRaw, which will be attached to this UnityWebRequest.

Examples

using UnityEngine;using UnityEngine.Networking;using System.Collections;using System.Collections.Generic;public class MyBehavior4 : MonoBehaviour{    void Start()    {        StartCoroutine(Upload());    }    IEnumerator Upload()    {        Dictionary<string, string> form = new();        form["myField"] = "myData";        using UnityWebRequest www = UnityWebRequest.Post("https://httpbin.org/post", form);        yield return www.SendWebRequest();        if (www.result != UnityWebRequest.Result.Success)        {            Debug.LogError(www.error);        }        else        {            Debug.Log("Form upload complete!");        }    }}