Rate Limit Profiles: updates a profile by id.

PUT /api/rate-limiting/profiles/{id} deprecated

Requires: RateLimiting.Profiles, RateLimiting.Profiles.Update, merchant scope.

**Required permissions**: `RateLimiting.Profiles`, `RateLimiting.Profiles.Update` **Scope**: merchant

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

cURL PowerShell TypeScript C# Python

cURL

curl -X PUT "{{BASE_URL}}/api/rate-limiting/profiles/{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/rate-limiting/profiles/{id}' `
    -Headers $headers -ContentType 'application/json' -Body $body

npm install @winkpg/winkpg-api

TypeScript (SDK)

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

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

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

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/rate-limiting/profiles/{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 RateLimitsApi(config);
var body = JsonSerializer.Deserialize<RateLimitProfileUpdateDto>("""
    {
      "name": ""
    }
    """);

var result = await api.RateLimitProfileUpdateAsync(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/rate-limiting/profiles/{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.RateLimitsApi(client)
    body = winkpg_api.RateLimitProfileUpdateDto.from_dict({
      "name": ""
    })
    result = api.rate_limit_profile_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/rate-limiting/profiles/{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
`name` required	string	Operator-facing name, unique within the tenant. nullablemax length 128
`description` required	string	Optional operator note explaining why the profile exists. nullablemax length 512
`scope` required	all of RateLimitScope	The scope the profile binds to.
`scopeIdentifier` required	string	The identifier at `scope` this profile targets. Leave empty to apply to every identifier at that scope. Conditional: When Scope == Global. nullablemax length 256
`priority` required	integer (int32)	Tie-break weight among equally specific profiles. Higher wins. min 0
`isActive` required	boolean	Whether the profile participates in resolution.
`concurrencyStamp` required	string	Optimistic concurrency token read from the loaded profile. nullable

This request body has no documented fields.