How do I do a patch request using HttpClient in dotnet core?

Question

I am trying to create a Patch request with theHttpClient in dotnet core. I have found the other methods,

using (var client = new HttpClient())
{
    client.GetAsync("/posts");
    client.PostAsync("/posts", ...);
    client.PutAsync("/posts", ...);
    client.DeleteAsync("/posts");
}

but can't seem to find the Patch option. Is it possible to do a Patch request with the HttpClient? If so, can someone show me an example how to do it?

use a `HttpRequestMessage` – Daniel A. White Oct 02 '16 at 12:08 — Daniel A. White, Oct 02 '16 at 12:08
Thanks @DanielA.White you got me on my way! – Tom Aalbers Oct 02 '16 at 13:37 — Tom Aalbers, Oct 02 '16 at 13:37

score 31 · Answer 1 · edited Nov 03 '22 at 10:02

31

Thanks to Daniel A. White's comment, I got the following working.

using (var client = new HttpClient())
{       
    var request = new HttpRequestMessage(new HttpMethod("PATCH"), "your-api-endpoint");

    try
    {
        response = await client.SendAsync(request);
    }
    catch (HttpRequestException ex)
    {
        // Failed
    }
}

EDIT: For .NET (Core) see @LxL answer.

edited Nov 03 '22 at 10:02

KoalaBear

2,755
2
25
29

answered Oct 02 '16 at 13:37

Tom Aalbers

4,574
5
29
51

15

where do you add the body? – DanielGatti Apr 10 '18 at 14:30
4

@DanielGatti is right. What are you sending as the body for your PATCH? What I did was add it to the object. request.Content = new StringContent(jsonString, Encoding.UTF8, "applicantion/json"); – DeadlyChambers Jul 30 '18 at 15:54
1

see my response on how to add body – diegosasw Mar 08 '19 at 17:27
6

I would suggest using `HttpMethod.Patch` rather than `"PATCH"`. – Anthony Jun 30 '20 at 18:50
Updated my answer and changed the accepted answer! – Tom Aalbers Jun 29 '22 at 16:52

score 12 · Answer 2 · answered Mar 08 '19 at 17:30

HttpClient does not have patch out of the box. Simply do something like this:

// more things here
using (var client = new HttpClient())
{
    client.BaseAddress = hostUri;
    client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Basic", base64Credentials);
    var method = "PATCH";
    var httpVerb = new HttpMethod(method);
    var httpRequestMessage =
        new HttpRequestMessage(httpVerb, path)
        {
            Content = stringContent
        };
    try
    {
        var response = await client.SendAsync(httpRequestMessage);
        if (!response.IsSuccessStatusCode)
        {
            var responseCode = response.StatusCode;
            var responseJson = await response.Content.ReadAsStringAsync();
            throw new MyCustomException($"Unexpected http response {responseCode}: {responseJson}");
        }
    }
    catch (Exception exception)
    {
        throw new MyCustomException($"Error patching {stringContent} in {path}", exception);
    }
}

LxL · Accepted Answer · 2022-02-28T18:08:59.420

7

As of Feb 2022

###Original Answer###

As of .Net Core 2.1, the PatchAsync() is now available for HttpClient

Reference: https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient.patchasync

edited Feb 28 '22 at 18:08

answered Sep 03 '19 at 21:57

LxL

1,878
2
20
39

1

PatchAsync exist in .Net Standard 2.1 only. – TheLegendaryCopyCoder Feb 25 '22 at 10:56

How do I do a patch request using HttpClient in dotnet core?

3 Answers3