Kard Organizations > Placements API

openapi: 3.2.0
info:
  title: Reference Organizations > Placements API
  version: 1.0.0
servers:
- url: https://rewards-api.getkard.com
  description: Production
- url: https://test-rewards-api.getkard.com
  description: Sandbox
tags:
- name: Organizations > Placements
paths:
  /v2/issuers/{organizationId}/placements:
    post:
      operationId: create
      summary: Create
      description: Create a placement for the organization. Use type "placement" for standard placements (requires name and availableSlots), "placementPushNotification" for push-notification placements (requires name and cadence; availableSlots is automatically set to 1), "placementEmail" for email placements (requires name, cadence, and availableSlots), "placementBatchActivation" for batch-activation placements (requires name, refreshInterval, and slots), or "placementGroup" for group placements (requires name and slots).
      tags:
      - Organizations > Placements
      parameters:
      - name: organizationId
        in: path
        description: Unique identifier of the organization
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Created placement resource
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_organizations_placements_PlacementFormatUnion'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons_ErrorResponse'
        '401':
          description: Error response with status 401
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons_ErrorResponse'
        '403':
          description: Error response with status 403
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons_ErrorResponse'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons_ErrorResponse'
        '500':
          description: Error response with status 500
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons_ErrorResponse'
      requestBody:
        description: Placement data for creation
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_organizations_placements_CreatePlacementRequestBody'
    get:
      operationId: list
      summary: List
      description: List placements belonging to the authenticated organization
      tags:
      - Organizations > Placements
      parameters:
      - name: organizationId
        in: path
        description: Unique identifier of the organization
        required: true
        schema:
          type: string
      - name: filter[type]
        in: query
        description: Filter by placement type (placement, placementPushNotification, placementEmail, placementBatchActivation, or placementGroup)
        required: false
        schema:
          $ref: '#/components/schemas/type_organizations_placements_PlacementTypeFilter'
      - name: filter[name]
        in: query
        description: Filter by exact placement name (unique within an organization per type)
        required: false
        schema:
          type: string
      - name: filter[contentStrategyId]
        in: query
        description: Filter by the ID of the content strategy linked to the placement
        required: false
        schema:
          type: string
      - name: include
        in: query
        description: 'CSV list of related resources to embed in the `included` array. Supported paths: `contentStrategy` (the direct content strategy of a non-batch placement), `slots` (the slot resources of a batch-activation or group placement), `slots.placement` (and the placement each slot references), and `slots.placement.contentStrategy` (and the content strategy of each referenced placement). Dotted paths implicitly include all intermediate resources.'
        required: false
        schema:
          type: string
      - name: page[after]
        in: query
        description: Cursor value for the next page of results
        required: false
        schema:
          type: string
      - name: page[size]
        in: query
        description: Maximum number of records to return [1 - 200] (default = 200)
        required: false
        schema:
          type: integer
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Paginated list of placements
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_organizations_placements_PlacementListResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons_ErrorResponse'
        '401':
          description: Error response with status 401
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons_ErrorResponse'
        '403':
          description: Error response with status 403
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons_ErrorResponse'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons_ErrorResponse'
        '500':
          description: Error response with status 500
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons_ErrorResponse'
  /v2/issuers/{organizationId}/placements/{placementId}:
    get:
      operationId: get
      summary: Get
      description: Retrieve a specific placement
      tags:
      - Organizations > Placements
      parameters:
      - name: organizationId
        in: path
        description: Unique identifier of the organization
        required: true
        schema:
          type: string
      - name: placementId
        in: path
        description: Unique identifier of the placement (UUID v7)
        required: true
        schema:
          type: string
      - name: include
        in: query
        description: 'CSV list of related resources to embed in the `included` array. Supported paths: `contentStrategy` (the direct content strategy of a non-batch placement), `slots` (the slot resources of a batch-activation or group placement), `slots.placement` (and the placement each slot references), and `slots.placement.contentStrategy` (and the content strategy of each referenced placement). Dotted paths implicitly include all intermediate resources.'
        required: false
        schema:
          type: string
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Placement resource (optionally with embedded related resources)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_organizations_placements_PlacementResource'
        '401':
          description: Error response with status 401
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons_ErrorResponse'
        '403':
          description: Error response with status 403
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons_ErrorResponse'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons_ErrorResponse'
        '500':
          description: Error response with status 500
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons_ErrorResponse'
    put:
      operationId: update
      summary: Update
      description: 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.
      tags:
      - Organizations > Placements
      parameters:
      - name: organizationId
        in: path
        description: Unique identifier of the organization
        required: true
        schema:
          type: string
      - name: placementId
        in: path
        description: Unique identifier of the placement (UUID v7)
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Updated placement resource
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_organizations_placements_PlacementFormatUnion'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons_ErrorResponse'
        '401':
          description: Error response with status 401
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons_ErrorResponse'
        '403':
          description: Error response with status 403
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons_ErrorResponse'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons_ErrorResponse'
        '500':
          description: Error response with status 500
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons_ErrorResponse'
      requestBody:
        description: Placement data for update
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_organizations_placements_UpdatePlacementRequestBody'
    delete:
      operationId: delete
      summary: Delete
      description: Delete a placement
      tags:
      - Organizations > Placements
      parameters:
      - name: organizationId
        in: path
        description: Unique identifier of the organization
        required: true
        schema:
          type: string
      - name: placementId
        in: path
        description: Unique identifier of the placement (UUID v7)
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_internal-organizations_DeleteResourceResponse'
        '401':
          description: Error response with status 401
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons_ErrorResponse'
        '403':
          description: Error response with status 403
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons_ErrorResponse'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons_ErrorResponse'
        '500':
          description: Error response with status 500
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons_ErrorResponse'
components:
  schemas:
    type_organizations_placements_ToManyRelationship:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/type_organizations_placements_ResourceIdentifier'
          description: The linked resource identifiers.
      required:
      - data
      description: A JSON:API to-many relationship payload.
      title: ToManyRelationship
    type_organizations_placements_CreateBatchActivationSlot:
      type: object
      properties:
        placementId:
          type: string
          description: 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:
          type: string
          description: Customer-defined alias for the slot, unique within the placement
        shortDescription:
          type: string
          description: Optional short description of the slot, limited to 50 characters
      required:
      - placementId
      - alias
      description: A slot in a batch-activation or group placement at creation time
      title: CreateBatchActivationSlot
    type_organizations_placements_PushNotificationPlacementAttributes:
      type: object
      properties:
        name:
          type: string
          description: Name of the placement
        organizationId:
          type: string
          description: ID of the organization this placement belongs to
        cadence:
          $ref: '#/components/schemas/type_organizations_placements_Cadence'
          description: Delivery cadence for the notification
        contentStrategyId:
          type: string
          description: ID of the content strategy linked to this placement, if any. Retained alongside `relationships.contentStrategy` for backward compatibility.
      required:
      - name
      - organizationId
      - cadence
      description: Attributes for a push-notification placement
      title: PushNotificationPlacementAttributes
    type_organizations_placements_UpdatePushNotificationAttributes:
      type: object
      properties:
        name:
          type: string
          description: Name of the placement
        cadence:
          $ref: '#/components/schemas/type_organizations_placements_Cadence'
          description: Delivery cadence for the notification
        contentStrategyId:
          type: string
          description: 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).
      required:
      - name
      - cadence
      description: Attributes for updating a push-notification placement. All fields are required.
      title: UpdatePushNotificationAttributes
    type_organizations_placements_CreateEmailAttributes:
      type: object
      properties:
        name:
          type: string
          description: Name of the placement
        availableSlots:
          type: integer
          description: Number of available slots (minimum 1)
        cadence:
          $ref: '#/components/schemas/type_organizations_placements_Cadence'
          description: Delivery cadence for the email
        contentStrategyId:
          type: string
          description: ID of the content strategy to link this placement to
      required:
      - name
      - availableSlots
      - cadence
      description: Attributes for creating an email placement
      title: CreateEmailAttributes
    type_internal-organizations_DeleteResourceResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/type_internal-organizations_DeleteResourceData'
      required:
      - data
      description: Response returned after deleting a resource
      title: DeleteResourceResponse
    type_organizations_placements_BatchActivationSlotAttributes:
      type: object
      properties:
        alias:
          type: string
          description: Customer-defined alias for the slot, unique within the placement.
        shortDescription:
          type: string
          description: Optional short description of the slot, limited to 50 characters.
      required:
      - alias
      description: Attributes block for a `batchActivationSlot` resource.
      title: BatchActivationSlotAttributes
    type_organizations_placements_CreatePlacementDataUnion:
      oneOf:
      - type: object
        properties:
          type:
            type: string
            enum:
            - placement
            description: 'Discriminator value: placement'
          attributes:
            $ref: '#/components/schemas/type_organizations_placements_CreateStandardAttributes'
            description: Standard placement attributes for creation
        required:
        - type
        - attributes
      - type: object
        properties:
          type:
            type: string
            enum:
            - placementPushNotification
            description: 'Discriminator value: placementPushNotification'
          attributes:
            $ref: '#/components/schemas/type_organizations_placements_CreatePushNotificationAttributes'
            description: Push-notification placement attributes for creation
        required:
        - type
        - attributes
      - type: object
        properties:
          type:
            type: string
            enum:
            - placementEmail
            description: 'Discriminator value: placementEmail'
          attributes:
            $ref: '#/components/schemas/type_organizations_placements_CreateEmailAttributes'
            description: Email placement attributes for creation
        required:
        - type
        - attributes
      - type: object
        properties:
          type:
            type: string
            enum:
            - placementBatchActivation
            description: 'Discriminator value: placementBatchActivation'
          attributes:
            $ref: '#/components/schemas/type_organizations_placements_CreateBatchActivationAttributes'
            description: Batch-activation placement attributes for creation
        required:
        - type
        - attributes
      - type: object
        properties:
          type:
            type: string
            enum:
            - placementGroup
            description: 'Discriminator value: placementGroup'
          attributes:
            $ref: '#/components/schemas/type_organizations_placements_CreateGroupAttributes'
            description: Group placement attributes for creation
        required:
        - type
        - attributes
      discriminator:
        propertyName: type
      description: Discriminated union for creating a placement
      title: CreatePlacementDataUnion
    type_internal-organizations_DeleteResourceData:
      type: object
      properties:
        type:
          type: string
          description: Resource type identifier
        id:
          type: string
          description: ID of the deleted resource
        attributes:
          $ref: '#/components/schemas/type_commons_EmptyObject'
      required:
      - type
      - id
      - attributes
      description: Deleted resource stub
      title: DeleteResourceData
    type_commons_CategoryOption:
      type: string
      enum:
      - Arts & Entertainment
      - Baby, Kids & Toys
      - Books & Digital Media
      - Clothing, Shoes & Accessories
      - Computers, Electronics & Software
      - Convenience
      - Gas
      - Department Stores
      - Food & Beverage
      - Health & Beauty
      - Home & Garden
      - Miscellaneous
      - Occasions & Gifts
      - Pets
      - Sports & Outdoors
      - Supplies & Services
      - Travel
      description: Category of merchant. Please use URL Encode for non single word categories. (Food & Beverage should be Food%20%26%20Beverage)
      title: CategoryOption
    type_organizations_placements_PlacementAttributes:
      type: object
      properties:
        name:
          type: string
          description: Name of the placement
        organizationId:
          type: string
          description: ID of the organization this placement belongs to
        availableSlots:
          type: integer
          description: Number of available slots
        contentStrategyId:
          type: string
          description: ID of the content strategy linked to this placement, if any. Retained alongside `relationships.contentStrategy` for backward compatibility.
      required:
      - name
      - organizationId
      - availableSlots
      description: Attributes for a standard placement
      title: PlacementAttributes
    type_organizations_placements_SlottedPlacementRelationships:
      type: object
      properties:
        slots:
          $ref: '#/components/schemas/type_organizations_placements_ToManyRelationship'
          description: 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).
      required:
      - slots
      description: Relationship block for a batch-activation or group placement.
      title: SlottedPlacementRelationships
    type_commons_EmptyObject:
      type: object
      properties: {}
      title: EmptyObject
    type_commons_ErrorObject:
      type: object
      properties:
        status:
          type: string
          description: Status code returned from the request
        title:
          type: string
          description: Name of error
        detail:
          type: string
          description: Description of the specific occurance of the error
        source:
          $ref: '#/components/schemas/type_commons_ErrorSource'
          description: An object containing a reference to the primary source of the error
        id:
          type: string
          description: The id of the resource which caused the error. Always returned for multi-status errors.
      required:
      - status
      - title
      - detail
      title: ErrorObject
    type_internal-organizations_OrganizationPaginationMetadata:
      type: object
      properties:
        pageSize:
          type: integer
          description: Number of items per page
        hasNextPage:
          type: boolean
          description: Whether more pages are available
      required:
      - pageSize
      - hasNextPage
      description: Pagination metadata for organization list responses
      title: OrganizationPaginationMetadata
    type_organizations_placements_CreateGroupAttributes:
      type: object
      properties:
        name:
          type: string
          description: Name of the placement
        slots:
          type: array
          items:
            $ref: '#/components/schemas/type_organizations_placements_CreateBatchActivationSlot'
          description: Slots that make up the group
      required:
      - name
      - slots
      description: Attributes for creating a group placement
      title: CreateGroupAttributes
    type_organizations_placements_CadenceFrequency:
      type: string
      enum:
      - DAILY
      - WEEKLY
      - MONTHLY
      description: How often a push notification or email placement delivers
      title: CadenceFrequency
    type_commons_Links:
      type: object
      properties:
        self:
          type: string
        prev:
          type: string
        next:
          type: string
      required:
      - self
      description: Related links to the API call
      title: Links
    type_organizations_placements_BatchActivationSlotRelationships:
      type: object
      properties:
        placement:
          $ref: '#/components/schemas/type_organizations_placements_ToOneRelationship'
          description: Reference to the placement that fills this slot. The referenced placement provides the slot's content strategy and offer-count cap; request `?include=slots.placement` to embed it in `included`.
      required:
      - placement
      description: Relationship block for a `batchActivationSlot` resource.
      title: BatchActivationSlotRelationships
    type_organizations_placements_UpdatePlacementDataUnion:
      oneOf:
      - type: object
        properties:
          type:
            type: string
            enum:
            - placement
            description: 'Discriminator value: placement'
          attributes:
            $ref: '#/components/schemas/type_organizations_placements_UpdateStandardAttributes'
            description: Standard placement attributes for update
        required:
        - type
        - attributes
      - type: object
        properties:
          type:
            type: string
            enum:
            - placementPushNotification
            description: 'Discriminator value: placementPushNotification'
          attributes:
            $ref: '#/components/schemas/type_organizations_placements_UpdatePushNotificationAttributes'
            description: Push-notification placement attributes for update
        required:
        - type
        - attributes
      - type: object
        properties:
          type:
            type: string
            enum:
            - placementEmail
            description: 'Discriminator value: placementEmail'
          attributes:
            $ref: '#/components/schemas/type_organizations_placements_UpdateEmailAttributes'
            description: Email placement attributes for update
        required:
        - type
        - attributes
      - type: object
        properties:
          type:
            type: string
            enum:
            - placementBatchActivation
            description: 'Discriminator value: placementBatchActivation'
          attributes:
            $ref: '#/components/schemas/type_organizations_placements_UpdateBatchActivationAttributes'
            description: Batch-activation placement attributes for update
        required:
        - type
        - attributes
      - type: object
        properties:
          type:
            type: string
            enum:
            - placementGroup
            description: 'Discriminator value: placementGroup'
          attributes:
            $ref: '#/components/schemas/type_organizations_placements_UpdateGroupAttributes'
            description: Group placement attributes for update
        required:
        - type
        - attributes
      discriminator:
        propertyName: type
      description: Discriminated union for updating a placement
      title: UpdatePlacementDataUnion
    type_organizations_placements_UpdateBatchActivationSlot:
      type: object
      properties:
        slotId:
          type: string
          description: 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:
          type: string
          description: 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:
          type: string
          description: Customer-defined alias for the slot, unique within the placement
        shortDescription:
          type: string
          description: Optional short description of the slot, limited to 50 characters
      required:
      - placementId
      - alias
      description: A slot in a batch-activation or group placement at update time
      title: UpdateBatchActivationSlot
    type_organizations_placements_CreateBatchActivationAttributes:
      type: object
      properties:
        name:
          type: string
          description: Name of the placement
        refreshInterval:
          type: string
          description: ISO-8601 duration controlling how often the activation cohort refreshes
        slots:
          type: array
          items:
            $ref: '#/components/schemas/type_organizations_placements_CreateBatchActivationSlot'
          description: Slots that make up the activation cohort
      required:
      - name
      - refreshInterval
      - slots
      description: Attributes for creating a batch-activation placement
      title: CreateBatchActivationAttributes
    type_organizations_contentStrategies_ContentStrategySort:
      type: string
      enum:
      - NEWLY_LIVE
      - EXPIRING_SOON
      - HIGHEST_CASHBACK
      - PERSONALIZED
      - OFFERS_NEAR_YOU
      description: Sort applied to the offers selected by a content strategy. A strategy may have at most one sort. The v1 starter set covers newly-live, expiring-soon, highest-cashback, personalized, and offers-near-you selections.
      title: ContentStrategySort
    type_organizations_contentStrategies_OfferFeatures:
      type: string
      enum:
      - INTERACTIVE
      description: Offer feature applied to the offers selected by a content strategy. A strategy may have any number of offer features.
      title: OfferFeatures
    type_commons_ErrorSource:
      type: object
      properties:
        pointer:
          type: string
          description: A JSON pointer to the value in the request document that caused the error
        parameter:
          type: string
          description: A string indicating which URI query parameter caused the error
        header:
          type: string
          description: A string indicating the name of a single request header which caused the error
      title: ErrorSource
    type_organizations_placements_UpdateStandardAttributes:
      type: object
      properties:
        name:
          type: string
          description: Name of the placement
        availableSlots:
          type: integer
          description: Number of available slots (minimum 1)
        contentStrategyId:
          type: string
          description: 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).
      required:
      - name
      - availableSlots
      description: Attributes for updating a standard placement. All fields are required.
      title: UpdateStandardAttributes
    type_organizations_contentStrategies_ContentStrategyFilters:
      type: object
      properties:
        categories:
          type: array
          items:
            type: string
          description: Merchant categories to include
        categoryExclusions:
          type: array
          items:
            type: string
          description: Merchant categories to exclude
        merchantExclusions:
          type: array
          items:
            type: string
          description: Merchant IDs to exclude
        offerFeatures:
          type: array
          items:
            $ref: '#/components/schemas/type_organizations_contentStrategies_OfferFeatures'
          description: Offer features to filter by
      description: Filters applied when selecting offers for a content strategy
      title: ContentStrategyFilters
    type_organizations_placements_DayOfWeek:
      type: string
      enum:
      - MON
      - TUE
      - WED
      - THU
      - FRI
      - SAT
      - SUN
      description: Day of the week (used when frequency is WEEKLY)
      title: DayOfWeek
    type_organizations_placements_UpdateBatchActivationAttributes:
      type: object
      properties:
        name:
          type: string
          description: Name of the placement
        refreshInterval:
          type: string
          description: ISO-8601 duration controlling how often the activation cohort refreshes
        slots:
          type: array
          

# --- truncated at 32 KB (51 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/kard/refs/heads/main/openapi/kard-organizations-placements-api-openapi.yml