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

Rate Limit Profiles: updates a profile by id.

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

**Operation ID:** `rateLimitProfileUpdate`

## Authorization

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

Requires API key scope: `admin`

Required permissions:
- `RateLimiting.Profiles`
- `RateLimiting.Profiles.Update`

## Parameters

| Name | In | Required | Type | Description |
| --- | --- | --- | --- | --- |
| id | path | yes | string(uuid) |  |
| suppressNulls | query | no | boolean | If true, omit properties with null values. |

## Request Body

**Content type:** `application/json`

Schema: [`RateLimitProfileUpdateDto`](https://devportal.demo.winkpg.io/docs/api/models/RateLimitProfileUpdateDto.md)

Properties:
- `name` (string) required: Operator-facing name, unique within the tenant. (nullable, max length 128)
- `description` (string): Optional operator note explaining why the profile exists. (nullable, max length 512)
- `scope` ([RateLimitScope](https://devportal.demo.winkpg.io/docs/api/models/RateLimitScope.md)): The scope the profile binds to.
  Values:
  - `Global`: Platform-wide limit shared across all tenants and merchants.
  - `PerTenant`: Per-tenant limit. Keyed by the tenant identifier.
  - `PerMerchant`: Per-merchant limit. Keyed by the merchant identifier.
  - `PerEntity`: Per-entity limit (for example a specific hosted payment page instance). Keyed by the identifier of that entity.
  - `PerEndpoint`: Per-endpoint limit. Keyed by the matched endpointPattern rather than the raw request path, so a pattern containing a wildcard produces one bounded counter key instead of one key per distinct URL.
  - `PerApiKey`: Per-API-key limit. Keyed by the API key identifier (never the key secret).
  - `PerIpAddress`: Per-IP-address limit. Keyed by the resolved client IP address.
- `scopeIdentifier` (string): The identifier at `scope` this profile targets. Leave empty to apply to every  identifier at that scope. Conditional: When Scope == Global. (nullable, max length 256)
- `priority` (integer(int32)): Tie-break weight among equally specific profiles. Higher wins. (min 0)
- `isActive` (boolean): Whether the profile participates in resolution.
- `concurrencyStamp` (string): Optimistic concurrency token read from the loaded profile. (nullable)

**Content type:** `text/json`

Schema: [`RateLimitProfileUpdateDto`](https://devportal.demo.winkpg.io/docs/api/models/RateLimitProfileUpdateDto.md)

Properties:
- `name` (string) required: Operator-facing name, unique within the tenant. (nullable, max length 128)
- `description` (string): Optional operator note explaining why the profile exists. (nullable, max length 512)
- `scope` ([RateLimitScope](https://devportal.demo.winkpg.io/docs/api/models/RateLimitScope.md)): The scope the profile binds to.
  Values:
  - `Global`: Platform-wide limit shared across all tenants and merchants.
  - `PerTenant`: Per-tenant limit. Keyed by the tenant identifier.
  - `PerMerchant`: Per-merchant limit. Keyed by the merchant identifier.
  - `PerEntity`: Per-entity limit (for example a specific hosted payment page instance). Keyed by the identifier of that entity.
  - `PerEndpoint`: Per-endpoint limit. Keyed by the matched endpointPattern rather than the raw request path, so a pattern containing a wildcard produces one bounded counter key instead of one key per distinct URL.
  - `PerApiKey`: Per-API-key limit. Keyed by the API key identifier (never the key secret).
  - `PerIpAddress`: Per-IP-address limit. Keyed by the resolved client IP address.
- `scopeIdentifier` (string): The identifier at `scope` this profile targets. Leave empty to apply to every  identifier at that scope. Conditional: When Scope == Global. (nullable, max length 256)
- `priority` (integer(int32)): Tie-break weight among equally specific profiles. Higher wins. (min 0)
- `isActive` (boolean): Whether the profile participates in resolution.
- `concurrencyStamp` (string): Optimistic concurrency token read from the loaded profile. (nullable)

**Content type:** `application/*+json`

Schema: [`RateLimitProfileUpdateDto`](https://devportal.demo.winkpg.io/docs/api/models/RateLimitProfileUpdateDto.md)

Properties:
- `name` (string) required: Operator-facing name, unique within the tenant. (nullable, max length 128)
- `description` (string): Optional operator note explaining why the profile exists. (nullable, max length 512)
- `scope` ([RateLimitScope](https://devportal.demo.winkpg.io/docs/api/models/RateLimitScope.md)): The scope the profile binds to.
  Values:
  - `Global`: Platform-wide limit shared across all tenants and merchants.
  - `PerTenant`: Per-tenant limit. Keyed by the tenant identifier.
  - `PerMerchant`: Per-merchant limit. Keyed by the merchant identifier.
  - `PerEntity`: Per-entity limit (for example a specific hosted payment page instance). Keyed by the identifier of that entity.
  - `PerEndpoint`: Per-endpoint limit. Keyed by the matched endpointPattern rather than the raw request path, so a pattern containing a wildcard produces one bounded counter key instead of one key per distinct URL.
  - `PerApiKey`: Per-API-key limit. Keyed by the API key identifier (never the key secret).
  - `PerIpAddress`: Per-IP-address limit. Keyed by the resolved client IP address.
- `scopeIdentifier` (string): The identifier at `scope` this profile targets. Leave empty to apply to every  identifier at that scope. Conditional: When Scope == Global. (nullable, max length 256)
- `priority` (integer(int32)): Tie-break weight among equally specific profiles. Higher wins. (min 0)
- `isActive` (boolean): Whether the profile participates in resolution.
- `concurrencyStamp` (string): Optimistic concurrency token read from the loaded profile. (nullable)

## Responses

### 200

OK

**Content type:** `application/json`

Schema: [`RateLimitProfileDto`](https://devportal.demo.winkpg.io/docs/api/models/RateLimitProfileDto.md)

Properties:
- `id` (string(uuid))
- `creationTime` (string(date-time)): The date and time when this entity was created.
- `creatorId` (string(uuid)): The ID of the user who created this entity. (nullable)
- `lastModificationTime` (string(date-time)): The date and time when this entity was last modified. (nullable)
- `lastModifierId` (string(uuid)): The ID of the user who last modified this entity. (nullable)
- `isDeleted` (boolean): Indicates whether this entity has been deleted.
- `deleterId` (string(uuid)): The ID of the user who deleted this entity, if it is deleted. (nullable)
- `deletionTime` (string(date-time)): The date and time when this entity was deleted, if it is deleted. (nullable)
- `name` (string): Operator-facing name. (nullable)
- `description` (string): Optional operator note. (nullable)
- `scope` ([RateLimitScope](https://devportal.demo.winkpg.io/docs/api/models/RateLimitScope.md)): The scope the profile binds to.
  Values:
  - `Global`: Platform-wide limit shared across all tenants and merchants.
  - `PerTenant`: Per-tenant limit. Keyed by the tenant identifier.
  - `PerMerchant`: Per-merchant limit. Keyed by the merchant identifier.
  - `PerEntity`: Per-entity limit (for example a specific hosted payment page instance). Keyed by the identifier of that entity.
  - `PerEndpoint`: Per-endpoint limit. Keyed by the matched endpointPattern rather than the raw request path, so a pattern containing a wildcard produces one bounded counter key instead of one key per distinct URL.
  - `PerApiKey`: Per-API-key limit. Keyed by the API key identifier (never the key secret).
  - `PerIpAddress`: Per-IP-address limit. Keyed by the resolved client IP address.
- `scopeIdentifier` (string): The identifier at that scope, or null when the profile applies to every identifier. (nullable)
- `priority` (integer(int32)): Tie-break weight among equally specific profiles. Higher wins.
- `isActive` (boolean): Whether the profile participates in resolution.
- `concurrencyStamp` (string): Optimistic concurrency token. (nullable)

### 403

Forbidden

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

### 401

Unauthorized

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

### 400

Bad Request

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

_Example: Request failed validation_

One or more fields were rejected before any rule ran. error.code is null on the envelope and the causes are in validationErrors, one entry per failure. An entry carries code when the validator declared a publishable one, and memberPaths when the full path says more than members does (an element inside a collection, for example). Both keys are omitted when they would add nothing.

```json
{
  "error": {
    "code": "null",
    "message": "Your request is not valid!",
    "details": "The following errors were detected during validation.",
    "data": {
      "correlationId": "0123456789abcdef0123456789abcdef"
    },
    "validationErrors": [
      {
        "message": "'Amount' must be greater than 0.",
        "members": [
          "amount"
        ]
      },
      {
        "message": "The card has expired.",
        "members": [
          "expirationDate"
        ],
        "code": "CardData:CardExpired"
      },
      {
        "message": "'Value' must not be empty.",
        "members": [
          "value"
        ],
        "memberPaths": [
          "customFields[2].value"
        ]
      }
    ]
  }
}
```

### 404

Not Found

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

_Example: Resource not found_

The id in the path names no record the caller can see. Most resources answer with a null error.code and a message naming the resource type and the id; a resource that publishes a not-found code in the catalog above carries it in error.code instead, so check for one before matching on the message.

```json
{
  "error": {
    "code": "null",
    "message": "There is no entity Transaction with id = 7d1f3a52-0c4e-4b8a-9e21-5a6b7c8d9e00!",
    "details": "null",
    "data": {
      "correlationId": "0123456789abcdef0123456789abcdef"
    },
    "validationErrors": "null"
  }
}
```

### 409

Conflict. The `concurrencyStamp` sent is not the resource's current one: the resource changed after it was read. Read the resource again and retry with the `concurrencyStamp` it returns. The body carries the standard error envelope.

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

### 501

Not Implemented

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

### 500

Internal Server Error

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

### default

The request failed. The body carries the standard error envelope: a machine-readable `error.code`, a human-readable `error.message`, and `error.validationErrors` when the failure was a validation rejection. The [error reference](https://devportal.demo.winkpg.io/docs/errors.md) lists the values `error.code` can take.

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

_Example: Business rule refused the request_

The request was understood and rejected by a platform rule. This is the shape that carries a code from the catalog above, so branch on error.code rather than on the message text. The HTTP status is the one listed against the code.

```json
{
  "error": {
    "code": "Transactions:OperationNotAllowed",
    "message": "The operation 'Void' is not allowed on a Sale transaction with result 'Approved' and settlement state 'Settled'.",
    "details": "null",
    "data": {
      "correlationId": "0123456789abcdef0123456789abcdef"
    },
    "validationErrors": "null"
  }
}
```

### 429

The request was refused because a rate limit was exceeded, or because something a later retry can clear stopped it. A rate limit refusal carries an `application/problem+json` body: wait at least the interval `Retry-After` names before retrying, then back off. Limits are tuned per deployment, so read the allowance from the response headers rather than assuming a fixed ceiling. Any other refusal carries the standard error envelope as `application/json`, and its `error.code` names the cause.

**Content type:** `application/problem+json`

Schema: [`RateLimitProblemDetails`](https://devportal.demo.winkpg.io/docs/api/models/RateLimitProblemDetails.md)

Properties:
- `type` (string) required: The problem type identifier. Always the same value: the failure is the status code itself,  so there is no sub-type for a caller to branch on. (nullable)
- `title` (string) required: A short, human-readable summary of the problem type. (nullable)
- `status` (integer(int32)) required: The HTTP status code, repeated in the body as the problem-details format defines.
- `detail` (string) required: A human-readable explanation of this occurrence of the problem. (nullable)
- `retryAfterSeconds` (integer(int32)) required: How long to wait before retrying, in whole seconds, carrying the same figure as the  `Retry-After` header. Always at least one: a value of zero would invite an immediate  retry that is certain to be rejected again.

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

## 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

```bash
curl -X PUT "{{BASE_URL}}/api/rate-limiting/profiles/{id}" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "name": ""
}'
```

### PowerShell

```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
```

### TypeScript (SDK)

```bash
npm install @winkpg/winkpg-api
```

```typescript
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)

```typescript
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();
```

### C# (SDK)

```bash
dotnet add package WinkPg.Api.Client
```

```csharp
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)

```csharp
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();
```

### Python (SDK)

```bash
pip install winkpg-api
```

```python
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)
```

### Python (raw HTTP)

```bash
pip install requests
```

```python
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()
```

## See also

- [All documentation](https://devportal.demo.winkpg.io/llms.txt): the machine-readable index of every public page on this site.