Kard Organizations > Placements API is one of 17 APIs that Kard publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.
Tagged areas include Organizations > Placements. The published artifact set on APIs.io includes an OpenAPI specification, authentication docs, and an AsyncAPI specification.
This API exposes
5 operations
across 2 paths,
and defines 49 schemas.
It is described by OpenAPI 3.2.0, at version 1.0.0.
Requests are made against 2 base URLs: https://rewards-api.getkard.com, https://test-rewards-api.getkard.com.
The identity and technical contract details declared by the specification.
type_organizations_placements_ToManyRelationship
object
A JSON:API to-many relationship payload.
1 property
1 required
type_organizations_placements_CreateBatchActivationSlot
object
A slot in a batch-activation or group placement at creation time
3 properties
2 required
type_organizations_placements_PushNotificationPlacementAttributes
object
Attributes for a push-notification placement
4 properties
3 required
type_organizations_placements_UpdatePushNotificationAttributes
object
Attributes for updating a push-notification placement. All fields are required.
3 properties
2 required
type_organizations_placements_CreateEmailAttributes
object
Attributes for creating an email placement
4 properties
3 required
type_internal-organizations_DeleteResourceResponse
object
Response returned after deleting a resource
1 property
1 required
type_organizations_placements_BatchActivationSlotAttributes
object
Attributes block for a batchActivationSlot resource.
2 properties
1 required
type_organizations_placements_CreatePlacementDataUnion
Discriminated union for creating a placement
type_internal-organizations_DeleteResourceData
object
Deleted resource stub
3 properties
3 required
type_commons_CategoryOption
string
Category of merchant. Please use URL Encode for non single word categories. (Food & Beverage should be Food%20%26%20Beverage)
type_organizations_placements_PlacementAttributes
object
Attributes for a standard placement
4 properties
3 required
type_organizations_placements_SlottedPlacementRelationships
object
Relationship block for a batch-activation or group placement.
1 property
1 required
type_commons_EmptyObject
object
type_commons_ErrorObject
object
5 properties
3 required
type_internal-organizations_OrganizationPaginationMetadata
object
Pagination metadata for organization list responses
2 properties
2 required
type_organizations_placements_CreateGroupAttributes
object
Attributes for creating a group placement
2 properties
2 required
type_organizations_placements_CadenceFrequency
string
How often a push notification or email placement delivers
type_commons_Links
object
Related links to the API call
3 properties
1 required
type_organizations_placements_BatchActivationSlotRelationships
object
Relationship block for a batchActivationSlot resource.
1 property
1 required
type_organizations_placements_UpdatePlacementDataUnion
Discriminated union for updating a placement
type_organizations_placements_UpdateBatchActivationSlot
object
A slot in a batch-activation or group placement at update time
4 properties
2 required
type_organizations_placements_CreateBatchActivationAttributes
object
Attributes for creating a batch-activation placement
3 properties
3 required
type_organizations_contentStrategies_ContentStrategySort
string
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-c…
type_organizations_contentStrategies_OfferFeatures
string
Offer feature applied to the offers selected by a content strategy. A strategy may have any number of offer features.
type_commons_ErrorSource
object
3 properties
type_organizations_placements_UpdateStandardAttributes
object
Attributes for updating a standard placement. All fields are required.
3 properties
2 required
type_organizations_contentStrategies_ContentStrategyFilters
object
Filters applied when selecting offers for a content strategy
4 properties
type_organizations_placements_DayOfWeek
string
Day of the week (used when frequency is WEEKLY)
type_organizations_placements_UpdateBatchActivationAttributes
object
Attributes for updating a batch-activation placement. All fields are required.
3 properties
3 required
type_commons_ErrorResponse
object
1 property
1 required
type_organizations_placements_UpdateGroupAttributes
object
Attributes for updating a group placement. All fields are required.
2 properties
2 required
type_organizations_placements_UpdatePlacementRequestBody
object
Request body for updating a placement
1 property
1 required
type_organizations_placements_CreateStandardAttributes
object
Attributes for creating a standard placement
3 properties
2 required
type_organizations_placements_ToOneRelationship
object
A JSON:API to-one relationship payload.
1 property
type_organizations_placements_ResourceIdentifier
object
A reference to another resource by type and id.
2 properties
2 required
type_organizations_placements_IncludedResource
Discriminated union of every resource type that can appear in the included array. The shape of each branch matches the corresponding primary-data resource (sam…
type_organizations_placements_GroupPlacementAttributes
object
Attributes for a group placement. A group is configured like a batch-activation placement but has no refreshInterval. Slot detail is exposed via relationships.…
2 properties
2 required
type_organizations_contentStrategies_ContentStrategyAttributes
object
Attributes for a content strategy
7 properties
6 required
type_organizations_placements_PlacementRelationships
object
Relationship block for non-batch placements. Mirrors the contentStrategyId attribute so JSON:API clients can walk the graph.
1 property
type_organizations_placements_UpdateEmailAttributes
object
Attributes for updating an email placement. All fields are required.
4 properties
3 required
type_organizations_placements_CreatePlacementRequestBody
object
Request body for creating a placement
1 property
1 required
type_organizations_placements_PlacementFormatUnion
Discriminated union for placement resources keyed on type
type_organizations_placements_PlacementTypeFilter
string
Placement type discriminator used as a list filter
type_organizations_placements_BatchActivationPlacementAttributes
object
Attributes for a batch-activation placement. Slot detail is exposed via relationships.slots (resource identifiers) and the batchActivationSlot entries in inclu…
3 properties
3 required
type_organizations_placements_PlacementResource
object
Single placement document, optionally with embedded related resources
2 properties
1 required
type_organizations_placements_CreatePushNotificationAttributes
object
Attributes for creating a push-notification placement
3 properties
2 required
type_organizations_placements_Cadence
object
Cadence schedule for push notification and email placements
4 properties
1 required
type_organizations_placements_PlacementListResponse
object
Paginated list of placements
4 properties
1 required
type_organizations_placements_EmailPlacementAttributes
object
Attributes for an email placement
5 properties
4 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Kard publishes across the network.
