Update reseller

PUT /api/resellers/{id} deprecated

Requires: Resellers.Resellers.Update, reseller scope.

Updates an existing reseller's account information and permissions.

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 ResellerUpdateDto. See the Request body section below for its fields.

cURL PowerShell TypeScript C# Python

cURL

curl -X PUT "{{BASE_URL}}/api/resellers/{id}" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "name": ""
}'

PowerShell

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

$body = @'
{
  "name": ""
}
'@

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

npm install @winkpg/winkpg-api

TypeScript (SDK)

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

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

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

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/resellers/{id}', {
  method: 'PUT',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "name": ""
  }),
});

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 ResellersApi(config);
var body = JsonSerializer.Deserialize<ResellerUpdateDto>("""
    {
      "name": ""
    }
    """);

var result = await api.ResellersUpdateAsync(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/resellers/{id}");
request.Headers.Add("api-key", "{{API_KEY}}");

request.Content = new StringContent("""
    {
      "name": ""
    }
    """, 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.ResellersApi(client)
    body = winkpg_api.ResellerUpdateDto.from_dict({
      "name": ""
    })
    result = api.resellers_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": ""
}

response = requests.request(
    "PUT",
    "{{BASE_URL}}/api/resellers/{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	nullablemin length 5max length 100
`parentReseller` required	string (uuid)	nullable
`customIdentifier` required	string	Conditional: When CustomIdentifier is not empty. Length: 5 to 100. nullable
`dba` required	string	Conditional: When Dba is not empty. Length: 5 to 100. nullable
`isTest` required	boolean
`code` required	string	nullableread only
`contactDetail` required	ResellerContactDetail	Represents contact details for a reseller.
`businessInfo` required	ResellerBusinessInfo	Represents business-related information for a reseller.
`features` required	ResellerFeatures
`branding` required	ResellerBranding	Represents branding information for a reseller, including domain, product, contact, and icon details.
`billingPreferences` required	all of ResellerBillingPreferences	Conditional: When BillingPreferences is not null.
`processingDefaults` required	all of ResellerProcessingDefaults	Portfolio-wide processing defaults applied to merchants under this reseller that have left the matching merchant-level setting unset. Nullable end to end: a reseller that never sets one changes nothing for its merchants. Conditional: When ProcessingDefaults is not null.
`notes` required	array of EntityNote	Operational notes attached to the reseller. nullable
`concurrencyStamp` required	string	nullable

This request body has no documented fields.