---
title: "Update"
method: PUT
path: "/v2/issuers/{organizationId}/placements/{placementId}"
tags: ["Organizations > Placements"]
---

# Update

`PUT /v2/issuers/{organizationId}/placements/{placementId}`

## Request

- Base URL: `https://rewards-api.getkard.com`
- URL: `https://rewards-api.getkard.com/v2/issuers/{organizationId}/placements/{placementId}`
- Auth: HTTP bearer

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.

## Path parameters

- `organizationId` string, required
- `placementId` string, required

## Request body

- OrganizationsPlacementsUpdatePlacementRequestBody: Request body for updating a placement
  - `data` union, required: Discriminated union for updating a placement
    - object
      - `type` 'placement', required: Discriminator value: placement
      - `attributes` OrganizationsPlacementsUpdateStandardAttributes, required: Attributes for updating a standard placement. All fields are required.
        - `name` string, required: Name of the placement
        - `displayName` string: Cardholder-facing title for the section (minimum 1 character). Omit to clear it (PUT requires the full attribute set).
        - `availableSlots` integer, required: Number of available slots (minimum 1)
        - `contentStrategyId` string: 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).
    - object
      - `type` 'placementPushNotification', required: Discriminator value: placementPushNotification
      - `attributes` OrganizationsPlacementsUpdatePushNotificationAttributes, required: Attributes for updating a push-notification placement. All fields are required.
        - `name` string, required: Name of the placement
        - `status` 'ACTIVE' | 'INACTIVE': Whether a scheduled placement's deliveries are paused. INACTIVE removes the placement's delivery schedule (push/email); ACTIVE re-creates it. Status has no effect on content serving.
        - `cadence` OrganizationsPlacementsCadence, required: Cadence schedule for push notification and email placements
          - `frequency` 'DAILY' | 'WEEKLY' | 'MONTHLY', required: How often a push notification or email placement delivers
          - `timeOfDay` string: Optional time of day in HH:mm format (24-hour, UTC)
          - `dayOfWeek` 'MON' | 'TUE' | 'WED' | 'THU' | 'FRI' | 'SAT' | 'SUN': Day of the week (used when frequency is WEEKLY, or with weekOfMonth)
          - `dayOfMonth` integer: Day of the month to deliver, 1-31 (used when frequency is MONTHLY, defaults to 1). For 29-31, months without that day deliver on their last day.
          - `weekOfMonth` 'FIRST' | 'LAST': Which occurrence of dayOfWeek in the month to deliver on
        - `contentStrategyId` string: 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).
    - object
      - `type` 'placementEmail', required: Discriminator value: placementEmail
      - `attributes` OrganizationsPlacementsUpdateEmailAttributes, required: Attributes for updating an email placement. All fields are required.
        - `name` string, required: Name of the placement
        - `status` 'ACTIVE' | 'INACTIVE': Whether a scheduled placement's deliveries are paused. INACTIVE removes the placement's delivery schedule (push/email); ACTIVE re-creates it. Status has no effect on content serving.
        - `availableSlots` integer, required: Number of available slots (minimum 1)
        - `cadence` OrganizationsPlacementsCadence, required: Cadence schedule for push notification and email placements
          - `frequency` 'DAILY' | 'WEEKLY' | 'MONTHLY', required: How often a push notification or email placement delivers
          - `timeOfDay` string: Optional time of day in HH:mm format (24-hour, UTC)
          - `dayOfWeek` 'MON' | 'TUE' | 'WED' | 'THU' | 'FRI' | 'SAT' | 'SUN': Day of the week (used when frequency is WEEKLY, or with weekOfMonth)
          - `dayOfMonth` integer: Day of the month to deliver, 1-31 (used when frequency is MONTHLY, defaults to 1). For 29-31, months without that day deliver on their last day.
          - `weekOfMonth` 'FIRST' | 'LAST': Which occurrence of dayOfWeek in the month to deliver on
        - `contentStrategyId` string: 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).
    - object
      - `type` 'placementBatchActivation', required: Discriminator value: placementBatchActivation
      - `attributes` OrganizationsPlacementsUpdateBatchActivationAttributes, required: 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` OrganizationsPlacementsUpdateBatchActivationSlot[], required: Slots that make up the activation cohort. Slots present in the prior state but absent from this list are removed.
          - `slotId` string: 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.
          - `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
          - `shortDescription` string: Optional short description of the slot, limited to 50 characters
    - object
      - `type` 'placementGroup', required: Discriminator value: placementGroup
      - `attributes` OrganizationsPlacementsUpdateGroupAttributes, required: Attributes for updating a group placement. All fields are required.
        - `name` string, required: Name of the placement
        - `slots` OrganizationsPlacementsUpdateBatchActivationSlot[], required: Slots that make up the group. Slots present in the prior state but absent from this list are removed.
          - `slotId` string: 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.
          - `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
          - `shortDescription` string: Optional short description of the slot, limited to 50 characters

## Response `200`

Updated placement resource

- union: Discriminated union for placement resources keyed on type
  - object
    - `type` 'placement', required: Discriminator value: placement
    - `id` string, required: Unique identifier of the placement (UUID v7)
    - `attributes` OrganizationsPlacementsPlacementAttributes, required: Attributes for a standard placement
      - `name` string, required: Name of the placement
      - `displayName` string: Cardholder-facing title for the section, if one was set. When absent, clients fall back to their own default label.
      - `organizationId` string, required: ID of the organization this placement belongs to
      - `availableSlots` integer, required: Number of available slots
      - `contentStrategyId` string: ID of the content strategy linked to this placement, if any. Retained alongside `relationships.contentStrategy` for backward compatibility.
    - `relationships` OrganizationsPlacementsPlacementRelationships: Relationship block for non-batch placements. Mirrors the `contentStrategyId` attribute so JSON:API clients can walk the graph.
      - `contentStrategy` OrganizationsPlacementsToOneRelationship: A JSON:API to-one relationship payload.
        - `data` OrganizationsPlacementsResourceIdentifier: 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.
  - object
    - `type` 'placementPushNotification', required: Discriminator value: placementPushNotification
    - `id` string, required: Unique identifier of the placement (UUID v7)
    - `attributes` OrganizationsPlacementsPushNotificationPlacementAttributes, required: Attributes for a push-notification placement
      - `name` string, required: Name of the placement
      - `status` 'ACTIVE' | 'INACTIVE', required: Whether a scheduled placement's deliveries are paused. INACTIVE removes the placement's delivery schedule (push/email); ACTIVE re-creates it. Status has no effect on content serving.
      - `organizationId` string, required: ID of the organization this placement belongs to
      - `cadence` OrganizationsPlacementsCadence, required: Cadence schedule for push notification and email placements
        - `frequency` 'DAILY' | 'WEEKLY' | 'MONTHLY', required: How often a push notification or email placement delivers
        - `timeOfDay` string: Optional time of day in HH:mm format (24-hour, UTC)
        - `dayOfWeek` 'MON' | 'TUE' | 'WED' | 'THU' | 'FRI' | 'SAT' | 'SUN': Day of the week (used when frequency is WEEKLY, or with weekOfMonth)
        - `dayOfMonth` integer: Day of the month to deliver, 1-31 (used when frequency is MONTHLY, defaults to 1). For 29-31, months without that day deliver on their last day.
        - `weekOfMonth` 'FIRST' | 'LAST': Which occurrence of dayOfWeek in the month to deliver on
      - `contentStrategyId` string: ID of the content strategy linked to this placement, if any. Retained alongside `relationships.contentStrategy` for backward compatibility.
      - `createdAt` string, date-time, required: When the placement was created
    - `relationships` OrganizationsPlacementsPlacementRelationships: Relationship block for non-batch placements. Mirrors the `contentStrategyId` attribute so JSON:API clients can walk the graph.
      - `contentStrategy` OrganizationsPlacementsToOneRelationship: A JSON:API to-one relationship payload.
        - `data` OrganizationsPlacementsResourceIdentifier: 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.
  - object
    - `type` 'placementEmail', required: Discriminator value: placementEmail
    - `id` string, required: Unique identifier of the placement (UUID v7)
    - `attributes` OrganizationsPlacementsEmailPlacementAttributes, required: Attributes for an email placement
      - `name` string, required: Name of the placement
      - `status` 'ACTIVE' | 'INACTIVE', required: Whether a scheduled placement's deliveries are paused. INACTIVE removes the placement's delivery schedule (push/email); ACTIVE re-creates it. Status has no effect on content serving.
      - `organizationId` string, required: ID of the organization this placement belongs to
      - `availableSlots` integer, required: Number of available slots
      - `cadence` OrganizationsPlacementsCadence, required: Cadence schedule for push notification and email placements
        - `frequency` 'DAILY' | 'WEEKLY' | 'MONTHLY', required: How often a push notification or email placement delivers
        - `timeOfDay` string: Optional time of day in HH:mm format (24-hour, UTC)
        - `dayOfWeek` 'MON' | 'TUE' | 'WED' | 'THU' | 'FRI' | 'SAT' | 'SUN': Day of the week (used when frequency is WEEKLY, or with weekOfMonth)
        - `dayOfMonth` integer: Day of the month to deliver, 1-31 (used when frequency is MONTHLY, defaults to 1). For 29-31, months without that day deliver on their last day.
        - `weekOfMonth` 'FIRST' | 'LAST': Which occurrence of dayOfWeek in the month to deliver on
      - `contentStrategyId` string: ID of the content strategy linked to this placement, if any. Retained alongside `relationships.contentStrategy` for backward compatibility.
      - `createdAt` string, date-time, required: When the placement was created
    - `relationships` OrganizationsPlacementsPlacementRelationships: Relationship block for non-batch placements. Mirrors the `contentStrategyId` attribute so JSON:API clients can walk the graph.
      - `contentStrategy` OrganizationsPlacementsToOneRelationship: A JSON:API to-one relationship payload.
        - `data` OrganizationsPlacementsResourceIdentifier: 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.
  - object
    - `type` 'placementBatchActivation', required: Discriminator value: placementBatchActivation
    - `id` string, required: Unique identifier of the placement (UUID v7)
    - `attributes` OrganizationsPlacementsBatchActivationPlacementAttributes, 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.
      - `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).
    - `relationships` OrganizationsPlacementsSlottedPlacementRelationships, required: Relationship block for a batch-activation or group placement.
      - `slots` OrganizationsPlacementsToManyRelationship, required: A JSON:API to-many relationship payload.
        - `data` OrganizationsPlacementsResourceIdentifier[], required: The linked resource identifiers.
          - `type` string, required: Discriminant of the referenced resource (e.g. `contentStrategy`).
          - `id` string, required: Identifier of the referenced resource.
  - object
    - `type` 'placementGroup', required: Discriminator value: placementGroup
    - `id` string, required: Unique identifier of the placement (UUID v7)
    - `attributes` OrganizationsPlacementsGroupPlacementAttributes, 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.
      - `name` string, required: Name of the placement
      - `organizationId` string, required: ID of the organization this placement belongs to
    - `relationships` OrganizationsPlacementsSlottedPlacementRelationships, required: Relationship block for a batch-activation or group placement.
      - `slots` OrganizationsPlacementsToManyRelationship, required: A JSON:API to-many relationship payload.
        - `data` OrganizationsPlacementsResourceIdentifier[], required: The linked resource identifiers.
          - `type` string, required: Discriminant of the referenced resource (e.g. `contentStrategy`).
          - `id` string, required: Identifier of the referenced resource.

## Other responses

- `400`: Error response with status 400
- `401`: Error response with status 401
- `403`: Error response with status 403
- `404`: Error response with status 404
- `429`: The issuer's traffic grew faster than its allowed rate, or the endpoint's own limit was reached. If the response includes a `Retry-After` header, wait that many seconds before retrying. See [Rate Limits](/2024-10-01/api/integration-guides/rate-limits).
- `500`: Error response with status 500

## Changes

- **2026-10-22** `4e87fc8b018b`: 1 info
  - added the non-success response with the status `429`
- **2026-10-19** `a664c5d23771`: 2 breaking, 2 info
  - removed `subschema #2, subschema #3` from the `data` request property `oneOf` list
  - added `subschema #2, subschema #3` to the response body `oneOf` list for the response status `200`
  - added `subschema #2, subschema #3` to the `data` request property `oneOf` list
  - removed `subschema #2, subschema #3` from the response body `oneOf` list for the response status `200`

[Operation history](https://skmtc.dev/getkard/apis/getkard-2/changes/v2/issuers/:organizationId/placements/:placementId/put.md)

---

[API](https://skmtc.dev/getkard/apis/getkard-2.md) - [All operations](https://skmtc.dev/getkard/apis/getkard-2/llms.txt) - [OpenAPI document](https://skmtc.dev/getkard/apis/getkard-2/revisions/bd47764afa21?raw)