Deliverable Detail

Provides detailed information for a specific deliverable by its unique identifier, including custom properties and configuration details.

Endpoint

GET /v1/admin/deliverables/{deliverableID}

Path Parameters

Parameter	Type	Required	Description
deliverableID	string	Yes	Unique identifier for the deliverable

Response

{
"code": 200,
"data": [
  {
    "uid": "7a7fb514951446e5a43f18c0be009671",
    "description": null,
    "isPercentage": false,
    "label": "Basketball Banners",
    "type": "Content",
    "imageName": "https://rapidmulestorage.blob.core.windows.net/images/e2a7a559-44f4-47e7-9eeb-e9ba613419ed_1000_F_494590444_O9S3i2PGbFcFmBcqzaK4vEF4mtCi1nnM.jpg",
    "details": [
      {
        "uid": "8523bf1d9ccc4e2bb8c86fe7238403dc",
        "label": "carousel_01",
        "value": "https://rapidmulestorage.blob.core.windows.net/images/cec1b338-5f4e-4945-9562-9e2094d8beef_rocket.png"
      },
      {
        "uid": "6f651d327a8f475da795f256d9699c75",
        "label": "carousel_02",
        "value": "https://rapidmulestorage.blob.core.windows.net/images/cec1b338-5f4e-4945-9562-9e2094d8beef_rocket.png"

Response Fields

Field	Type	Description
uid	string	Unique identifier for the deliverable
label	string	Display name of the deliverable
description	string	Description of the deliverable's purpose
type	string	Deliverable type: Prize, Content, or Notification
imageName	string	URL to the deliverable's icon/image
isPercentage	boolean	Whether the amount represents a percentage
details	array	Custom properties attached to the deliverable

Request Example

curl -X GET https://api.rapidmule.com/v1/admin/deliverables/{{deliverableID}} \
  -H "Authorization: Bearer YOUR_API_KEY"

Custom Properties (Details)

The details array contains custom properties that provide additional context or configuration for the deliverable.

Content Type Example

For Content-type deliverables (banners, carousels):

"details": [
  {
    "label": "carousel_01",
    "value": "https://example.com/banner1.jpg"
  },
  {
    "label": "carousel_02",
    "value": "https://example.com/banner2.jpg"
  }
]

Prize Type Example

For Prize-type deliverables (coupons, free bets):

"details": [
  {
    "label": "valid_for_days",
    "value": "60"
  },
  {
    "label": "target_id",
    "value": "2023_amazon_discount"
  }
]

Notification Type Example

For Notification-type deliverables:

"details": [
  {
    "label": "target",
    "value": "system"
  }
]

Use Cases

• Content Carousel: Extract carousel images from Content-type deliverables
• Coupon Configuration: Get coupon validity periods and other properties
• Feature Unlock Data: Retrieve feature unlock information from Notification deliverables

Error Codes

Code	Description	Resolution
1001	Payload is null	Check path parameters
4001	Invalid AuthKey	Verify API key
9006	Deliverable does not exist	Use valid deliverableId

Related Endpoints

• Get Deliverables - List all deliverables
• Player Management - View player inventory