Skip to main content

Action Detail

Provides detailed information for a specific action by its unique identifier, including any deliverables associated with it.

Endpoint​

GET /v1/admin/actions/{actionID}

Path Parameters​

ParameterTypeRequiredDescription
actionIDstringYesUnique identifier for the action

Response​

{
"code": 200,
"data": [
{
"uid": "c1991d02872947e78435d15602b48581",
"identifier": "Bet",
"points": 1,
"pointGap": 0,
"cost": 0,
"costLabel": null,
"createDate": "2023-08-15T10:10:46.293",
"imageName": "https://rapidmulestorage.blob.core.windows.net/images/6c511fde-de2c-4a50-9ddb-1407061d5b46_casino-chip.png",
"isUserAttribute": false,
"isActive": true,
"deliverables": null

Response Fields​

FieldTypeDescription
uidstringUnique identifier for the action
identifierstringThe action name/identifier
pointsnumberPoints awarded for this action
pointGapnumberMinimum time gap between point awards
costnumberCost to perform this action (if applicable)
costLabelstringLabel for the cost deliverable
createDatestringISO 8601 timestamp of when the action was created
imageNamestringURL to the action's icon/image
isUserAttributebooleanWhether this action represents a user attribute
isActivebooleanWhether this action is currently active
deliverablesarrayDeliverables associated with this action (if any)

Request Example​

curl -X GET https://api.rapidmule.com/v1/admin/actions/{{actionID}} \
-H "AuthKey: YOUR_API_KEY"

Use Cases​

  • Action Configuration: View detailed settings for specific actions
  • Deliverables Inspection: Check associated deliverables and rewards
  • Action Verification: Verify action status before processing

Error Codes​

CodeDescriptionResolution
1001Payload is nullCheck path parameters
4001Invalid AuthKeyVerify API key
9001Action does not existUse valid actionId
Related Endpoints