> This page is for version 2024-10-01 (default).
> For other versions, use one of these documentation indexes:
> - 2024-10-01 (default): https://docs.getkard.com/2024-10-01/llms.txt
> - Legacy: https://docs.getkard.com/legacy/llms.txt

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.getkard.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.getkard.com/_mcp/server.

# Update

PUT https://rewards-api.getkard.com/v2/issuers/{organizationId}/placements/{placementId}
Content-Type: application/json

Replace a placement. All fields must be provided. Use type "placement", "placementPushNotification", "placementEmail", "placementBatchActivation", or "placementGroup" to set the placement kind. If the type is "placementPushNotification", availableSlots is automatically set to 1.

Reference: https://docs.getkard.com/api/organizations/placements/update

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Servers

- `https://rewards-api.getkard.com` (Production, default)
- `https://test-rewards-api.getkard.com` (Sandbox)

## Request

### Path parameters

- `organizationId` (string, required) — Unique identifier of the organization
- `placementId` (string, required) — Unique identifier of the placement (UUID v7)

### Body (application/json)

This endpoint expects an UpdatePlacementRequestBody.

- `data` (UpdatePlacementDataUnion, required) — Placement data for update

## Response

### 200

Updated placement resource

- `PlacementFormatUnion`
  - `type`: `placement`
    - `attributes` (PlacementAttributes, required) — Attributes for a standard placement
    - `id` (string, required) — Unique identifier of the placement (UUID v7)
    - `relationships` (PlacementRelationships, optional) — JSON:API relationships for the placement. Omitted entirely when the placement has no linked resources.
  - `type`: `placementPushNotification`
    - `attributes` (PushNotificationPlacementAttributes, required) — Attributes for a push-notification placement
    - `id` (string, required) — Unique identifier of the placement (UUID v7)
    - `relationships` (PlacementRelationships, optional) — JSON:API relationships for the placement. Omitted entirely when the placement has no linked resources.
  - `type`: `placementEmail`
    - `attributes` (EmailPlacementAttributes, required) — Attributes for an email placement
    - `id` (string, required) — Unique identifier of the placement (UUID v7)
    - `relationships` (PlacementRelationships, optional) — JSON:API relationships for the placement. Omitted entirely when the placement has no linked resources.
  - `type`: `placementBatchActivation`
    - `attributes` (BatchActivationPlacementAttributes, required) — Attributes for a batch-activation placement. Slot detail is exposed via `relationships.slots` (resource identifiers) and the `batchActivationSlot` entries in `included`; request `?include=slots` (or a deeper path) to get the slot details.
    - `id` (string, required) — Unique identifier of the placement (UUID v7)
    - `relationships` (SlottedPlacementRelationships, required) — JSON:API relationships for the placement. Always present on a batch-activation placement; the `slots` to-many relationship lists the slot resource identifiers.
  - `type`: `placementGroup`
    - `attributes` (GroupPlacementAttributes, required) — Attributes for a group placement. A group is configured like a batch-activation placement but has no refreshInterval. Slot detail is exposed via `relationships.slots` (resource identifiers) and the `batchActivationSlot` entries in `included`; request `?include=slots` (or a deeper path) to get the slot details.
    - `id` (string, required) — Unique identifier of the placement (UUID v7)
    - `relationships` (SlottedPlacementRelationships, required) — JSON:API relationships for the placement. Always present on a group placement; the `slots` to-many relationship lists the slot resource identifiers.

## Errors

### 401 Unauthorized Error

- `errors` (list of ErrorObject, required)

### 403 Forbidden Error

- `errors` (list of ErrorObject, required)

### 400 Invalid Request

- `errors` (list of ErrorObject, required)

### 404 Does Not Exist Error

- `errors` (list of ErrorObject, required)

### 500 Internal Server Error

- `errors` (list of ErrorObject, required)

## Types

### UpdatePlacementDataUnion

Discriminated union for updating a placement

- `type`: `placement`
  - `attributes` (UpdateStandardAttributes, required) — Standard placement attributes for update
- `type`: `placementPushNotification`
  - `attributes` (UpdatePushNotificationAttributes, required) — Push-notification placement attributes for update
- `type`: `placementEmail`
  - `attributes` (UpdateEmailAttributes, required) — Email placement attributes for update
- `type`: `placementBatchActivation`
  - `attributes` (UpdateBatchActivationAttributes, required) — Batch-activation placement attributes for update
- `type`: `placementGroup`
  - `attributes` (UpdateGroupAttributes, required) — Group placement attributes for update

### PlacementAttributes

Attributes for a standard placement

- `name` (string, required) — Name of the placement
- `organizationId` (string, required) — ID of the organization this placement belongs to
- `availableSlots` (integer, required) — Number of available slots
- `displayName` (string, optional) — Cardholder-facing title for the section, if one was set. When absent, clients fall back to their own default label.
- `contentStrategyId` (string, optional) — ID of the content strategy linked to this placement, if any. Retained alongside `relationships.contentStrategy` for backward compatibility.

### PlacementRelationships

Relationship block for non-batch placements. Mirrors the `contentStrategyId` attribute so JSON:API clients can walk the graph.

- `contentStrategy` (ToOneRelationship, optional) — Relationship to the content strategy that powers this placement. Present whenever the placement has been linked to a content strategy (`data.id` will be set). Omitted entirely when no content strategy is linked.

### PushNotificationPlacementAttributes

Attributes for a push-notification placement

- `name` (string, required) — Name of the placement
- `status` (enum, required) — Whether the placement's scheduled deliveries are paused. Has no effect on content serving.
  - Allowed values: `ACTIVE`, `INACTIVE`
- `organizationId` (string, required) — ID of the organization this placement belongs to
- `cadence` (Cadence, required) — Delivery cadence for the notification
- `contentStrategyId` (string, optional) — ID of the content strategy linked to this placement, if any. Retained alongside `relationships.contentStrategy` for backward compatibility.

### EmailPlacementAttributes

Attributes for an email placement

- `name` (string, required) — Name of the placement
- `status` (enum, required) — Whether the placement's scheduled deliveries are paused. Has no effect on content serving.
  - Allowed values: `ACTIVE`, `INACTIVE`
- `organizationId` (string, required) — ID of the organization this placement belongs to
- `availableSlots` (integer, required) — Number of available slots
- `cadence` (Cadence, required) — Delivery cadence for the email
- `contentStrategyId` (string, optional) — ID of the content strategy linked to this placement, if any. Retained alongside `relationships.contentStrategy` for backward compatibility.

### BatchActivationPlacementAttributes

Attributes for a batch-activation placement. Slot detail is exposed via `relationships.slots` (resource identifiers) and the `batchActivationSlot` entries in `included`; request `?include=slots` (or a deeper path) to get the slot details.

- `name` (string, required) — Name of the placement
- `organizationId` (string, required) — ID of the organization this placement belongs to
- `refreshInterval` (string, required) — ISO-8601 duration that controls how often the activation cohort refreshes (e.g. "P7D" for weekly).

### SlottedPlacementRelationships

Relationship block for a batch-activation or group placement.

- `slots` (ToManyRelationship, required) — Resource identifiers for the slots that make up the placement. Each entry corresponds to a `batchActivationSlot` resource that appears in `included` when the request asks for `slots` (or any deeper path that implies it).

### GroupPlacementAttributes

Attributes for a group placement. A group is configured like a batch-activation placement but has no refreshInterval. Slot detail is exposed via `relationships.slots` (resource identifiers) and the `batchActivationSlot` entries in `included`; request `?include=slots` (or a deeper path) to get the slot details.

- `name` (string, required) — Name of the placement
- `organizationId` (string, required) — ID of the organization this placement belongs to

### ErrorObject

- `status` (string, required) — Status code returned from the request
- `title` (string, required) — Name of error
- `detail` (string, required) — Description of the specific occurance of the error
- `source` (ErrorSource, optional) — An object containing a reference to the primary source of the error
- `id` (string, optional) — The id of the resource which caused the error. Always returned for multi-status errors.

### UpdateStandardAttributes

Attributes for updating a standard placement. All fields are required.

- `name` (string, required) — Name of the placement
- `availableSlots` (integer, required) — Number of available slots (minimum 1)
- `displayName` (string, optional) — Cardholder-facing title for the section (minimum 1 character). Omit to clear it (PUT requires the full attribute set).
- `contentStrategyId` (string, optional) — ID of the content strategy to link this placement to. Omit to clear any existing link (PUT requires the full attribute set, so a missing value unlinks the placement).

### UpdatePushNotificationAttributes

Attributes for updating a push-notification placement. All fields are required.

- `name` (string, required) — Name of the placement
- `cadence` (Cadence, required) — Delivery cadence for the notification
- `status` (enum, optional) — Placement status. Defaults to ACTIVE on create; when omitted on update, the current status is preserved.
  - Allowed values: `ACTIVE`, `INACTIVE`
- `contentStrategyId` (string, optional) — ID of the content strategy to link this placement to. Omit to clear any existing link (PUT requires the full attribute set, so a missing value unlinks the placement).

### UpdateEmailAttributes

Attributes for updating an email placement. All fields are required.

- `name` (string, required) — Name of the placement
- `availableSlots` (integer, required) — Number of available slots (minimum 1)
- `cadence` (Cadence, required) — Delivery cadence for the email
- `status` (enum, optional) — Placement status. Defaults to ACTIVE on create; when omitted on update, the current status is preserved.
  - Allowed values: `ACTIVE`, `INACTIVE`
- `contentStrategyId` (string, optional) — ID of the content strategy to link this placement to. Omit to clear any existing link (PUT requires the full attribute set, so a missing value unlinks the placement).

### UpdateBatchActivationAttributes

Attributes for updating a batch-activation placement. All fields are required.

- `name` (string, required) — Name of the placement
- `refreshInterval` (string, required) — ISO-8601 duration controlling how often the activation cohort refreshes
- `slots` (list of UpdateBatchActivationSlot, required) — Slots that make up the activation cohort. Slots present in the prior state but absent from this list are removed.

### UpdateGroupAttributes

Attributes for updating a group placement. All fields are required.

- `name` (string, required) — Name of the placement
- `slots` (list of UpdateBatchActivationSlot, required) — Slots that make up the group. Slots present in the prior state but absent from this list are removed.

### ToOneRelationship

A JSON:API to-one relationship payload.

- `data` (ResourceIdentifier, optional) — The linked resource identifier, or null when the relationship is present but unlinked.

### Cadence

Cadence schedule for push notification and email placements

- `frequency` (enum, required) — Delivery frequency
  - Allowed values: `DAILY`, `WEEKLY`, `MONTHLY`
- `timeOfDay` (string, optional) — Optional time of day in HH:mm format (24-hour, UTC)
- `dayOfWeek` (enum, optional) — Day of the week to deliver (used when frequency is WEEKLY, defaults to MON)
  - Allowed values: `MON`, `TUE`, `WED`, `THU`, `FRI`, `SAT`, `SUN`
- `dayOfMonth` (integer, optional) — Day of the month to deliver, 1-31 (used when frequency is MONTHLY, defaults to 1)

### ToManyRelationship

A JSON:API to-many relationship payload.

- `data` (list of ResourceIdentifier, required) — The linked resource identifiers.

### ErrorSource

- `pointer` (string, optional) — A JSON pointer to the value in the request document that caused the error
- `parameter` (string, optional) — A string indicating which URI query parameter caused the error
- `header` (string, optional) — A string indicating the name of a single request header which caused the error

### UpdateBatchActivationSlot

A slot in a batch-activation or group placement at update time

- `placementId` (string, required) — ID of another placement that fills this slot. The referenced placement provides both the content strategy and the limit on the number of offers available to the slot.
- `alias` (string, required) — Customer-defined alias for the slot, unique within the placement
- `slotId` (string, optional) — Existing slot identifier. Echo the value from a prior GET to keep the slot stable; omit to mint a fresh slot. If the placementId changes, the slotId is regenerated regardless of what was echoed.
- `shortDescription` (string, optional) — Optional short description of the slot, limited to 50 characters

### ResourceIdentifier

A reference to another resource by type and id.

- `type` (string, required) — Discriminant of the referenced resource (e.g. `contentStrategy`).
- `id` (string, required) — Identifier of the referenced resource.

## Examples

**Request**

```json
{
  "data": {
    "type": "placement",
    "attributes": {
      "name": "name",
      "availableSlots": 1
    }
  }
}
```

**Response**

```json
{
  "type": "placement",
  "attributes": {
    "name": "name",
    "organizationId": "organizationId",
    "availableSlots": 1,
    "displayName": "displayName",
    "contentStrategyId": "contentStrategyId"
  },
  "id": "id",
  "relationships": {
    "contentStrategy": {
      "data": {
        "type": "type",
        "id": "id"
      }
    }
  }
}
```

**SDK Code**

```python
import requests

url = "https://rewards-api.getkard.com/v2/issuers/organizationId/placements/placementId"

payload = { "data": {
        "type": "placement",
        "attributes": {
            "name": "name",
            "availableSlots": 1
        }
    } }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://rewards-api.getkard.com/v2/issuers/organizationId/placements/placementId';
const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"data":{"type":"placement","attributes":{"name":"name","availableSlots":1}}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://rewards-api.getkard.com/v2/issuers/organizationId/placements/placementId"

	payload := strings.NewReader("{\n  \"data\": {\n    \"type\": \"placement\",\n    \"attributes\": {\n      \"name\": \"name\",\n      \"availableSlots\": 1\n    }\n  }\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://rewards-api.getkard.com/v2/issuers/organizationId/placements/placementId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"data\": {\n    \"type\": \"placement\",\n    \"attributes\": {\n      \"name\": \"name\",\n      \"availableSlots\": 1\n    }\n  }\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.put("https://rewards-api.getkard.com/v2/issuers/organizationId/placements/placementId")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"data\": {\n    \"type\": \"placement\",\n    \"attributes\": {\n      \"name\": \"name\",\n      \"availableSlots\": 1\n    }\n  }\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://rewards-api.getkard.com/v2/issuers/organizationId/placements/placementId', [
  'body' => '{
  "data": {
    "type": "placement",
    "attributes": {
      "name": "name",
      "availableSlots": 1
    }
  }
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://rewards-api.getkard.com/v2/issuers/organizationId/placements/placementId");
var request = new RestRequest(Method.PUT);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"data\": {\n    \"type\": \"placement\",\n    \"attributes\": {\n      \"name\": \"name\",\n      \"availableSlots\": 1\n    }\n  }\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = ["data": [
    "type": "placement",
    "attributes": [
      "name": "name",
      "availableSlots": 1
    ]
  ]] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://rewards-api.getkard.com/v2/issuers/organizationId/placements/placementId")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PUT"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```