Update customer

PUT /api/customers/{id} deprecated

Requires: Customers.Customers, Customers.Customers.Update, merchant scope.

Updates an existing customer's information and payment preferences.

Signed in, you can send this request to your own sandbox merchant from the console and read the answer. Sign in to try it.

Example request

Every block below sends the same request. Replace {{BASE_URL}} with the address of the API you are calling and {{API_KEY}} with your own key.

The request body is a CustomerUpdateDto. See the Request body section below for its fields.

cURL PowerShell TypeScript C# Python

cURL

curl -X PUT "{{BASE_URL}}/api/customers/{id}" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "",
  "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}'

PowerShell

$headers = @{
    'api-key' = '{{API_KEY}}'
}

$body = @'
{
  "name": "",
  "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
'@

$response = Invoke-RestMethod -Method PUT -Uri '{{BASE_URL}}/api/customers/{id}' `
    -Headers $headers -ContentType 'application/json' -Body $body

npm install @winkpg/winkpg-api

TypeScript (SDK)

import { Configuration, CustomersApi } from '@winkpg/winkpg-api';

const api = new CustomersApi(new Configuration({
  basePath: '{{BASE_URL}}',
  apiKey: '{{API_KEY}}',
}));

const { data } = await api.customersUpdate("3fa85f64-5717-4562-b3fc-2c963f66afa6", {
  "name": "",
  "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
});

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/customers/{id}', {
  method: 'PUT',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "name": "",
    "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  }),
});

const data = await response.json();

dotnet add package WinkPg.Api.Client

C# (SDK)

using WinkPg.Api.Client.Api;
using WinkPg.Api.Client.Client;
using System.Text.Json;

var config = new Configuration { BasePath = "{{BASE_URL}}" };
config.AddApiKey("api-key", "{{API_KEY}}");

var api = new CustomersApi(config);
var body = JsonSerializer.Deserialize<CustomerUpdateDto>("""
    {
      "name": "",
      "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
    """);

var result = await api.CustomersUpdateAsync(Guid.Parse("3fa85f64-5717-4562-b3fc-2c963f66afa6"), body);

C# (raw HTTP)

using System.Text;

using var http = new HttpClient { BaseAddress = new Uri("{{BASE_URL}}") };

var request = new HttpRequestMessage(new HttpMethod("PUT"), "/api/customers/{id}");
request.Headers.Add("api-key", "{{API_KEY}}");

request.Content = new StringContent("""
    {
      "name": "",
      "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
    """, Encoding.UTF8, "application/json");

var response = await http.SendAsync(request);
response.EnsureSuccessStatusCode();
var json = await response.Content.ReadAsStringAsync();

pip install winkpg-api

Python (SDK)

import winkpg_api

configuration = winkpg_api.Configuration(host="{{BASE_URL}}")
configuration.api_key["ApiKey"] = "{{API_KEY}}"

with winkpg_api.ApiClient(configuration) as client:
    api = winkpg_api.CustomersApi(client)
    body = winkpg_api.CustomerUpdateDto.from_dict({
      "name": "",
      "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    })
    result = api.customers_update("3fa85f64-5717-4562-b3fc-2c963f66afa6", body)

pip install requests

Python (raw HTTP)

import requests

headers = {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
}

body = {
  "name": "",
  "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

response = requests.request(
    "PUT",
    "{{BASE_URL}}/api/customers/{id}",
    headers=headers,
    json=body,
)
response.raise_for_status()
data = response.json()

Parameters

Name	In	Type	Description
`id` required	path	string (uuid)
`suppressNulls` required	query	boolean	If true, omit properties with null values.

Request body

application/json , required

Field	Type	Description
`createdFromTemplateId` required	string (uuid)	nullable
`name` required	string	Gets or sets the name of the customer. Must be unique within the owning merchant, compared case-insensitively. Use `displayName` for a human label that may repeat. nullablemin length 2max length 100
`displayName` required	string	An optional human-readable label for the customer that is deliberately not unique. Supply it when the recognisable name for two customers is legitimately the same and `name` carries an external key instead. When present it is what merchants see wherever customers are listed; when absent those surfaces fall back to `name`. At most 100 characters. nullablemax length 100
`merchantAssignedId` required	string	An optional identifier the merchant assigns to the customer as a friendly reference, distinct from the system Guid `id` and the server-owned legacy number. Surfaces the v1 API's `CustomerId` field. Not an `EditFormField`: it is set through the API rather than the standard customer form. nullablemax length 50
`merchantId` required	string (uuid)	Gets or sets the identifier of the merchant that owns this customer.
`isActive` required	boolean	Gets or sets a value indicating whether this customer is active.
`contactDetail` required	all of CustomerContactDetail	Gets or sets the customer's contact details (email, phone, address).
`tags` required	array of EntityTag	Gets or sets the collection of tags used to categorize or label this customer. nullable
`storedPaymentMethods` required	array of CustomerStoredPaymentMethod	Gets or sets the customer's stored payment methods for recurring or future transactions. nullable
`contracts` required	array of Contract	Gets or sets the recurring billing contracts associated with this customer. nullable
`notes` required	array of EntityNote	Operational notes attached to the customer. nullable
`concurrencyStamp` required	string	Gets or sets the concurrency stamp used for optimistic concurrency control. nullable

This request body has no documented fields.