UnityWebRequest.Post

Parameters

Returns

UnityWebRequest A UnityWebRequest configured to send string to uri via POST.

Description

Creates a UnityWebRequest configured to send form data to a server via HTTP POST.

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.

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!");
            }
        }
    }
}

Parameters

Returns

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

Description

Create a UnityWebRequest configured to send form data to a server via HTTP POST.

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.

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!");
        }
    }
}

Parameters

Returns

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

Description

Create a UnityWebRequest configured to send form data to a server via HTTP POST.

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.

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!");
        }
    }
}

Parameters

Returns

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

Description

Create a UnityWebRequest configured to send form data to a server via HTTP POST.

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.

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!");
        }
    }
}