{"info":{"_postman_id":"4effa175-9d3e-4868-b041-3606c34bdb8c","name":"Gamifier","description":"

Gamifier helps gamify your applications to drive user engagement and more customer activity, and sales.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"5815935","collectionId":"4effa175-9d3e-4868-b041-3606c34bdb8c","publishedId":"2sAYJ4hfGk","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-12-23T14:30:07.000Z"},"item":[{"name":"Applications","item":[{"name":"List Applications","id":"019294b0-933a-4345-8aa3-3c34b94d18e4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{Scheme}}://{{Hostname}}/api/v{{ApiVersion}}/applications","description":"

Response

The response for this request can be described using the following JSON schema:

{\n  \"type\": \"object\",\n  \"properties\": {\n    \"data\": {\n      \"type\": \"array\",\n      \"items\": {\n        \"type\": \"object\",\n        \"properties\": {\n          \"name\": { \"type\": \"string\" },\n          \"activated_at\": { \"type\": [\"string\", \"null\"] },\n          \"created_at\": { \"type\": \"string\" },\n          \"updated_at\": { \"type\": \"string\" },\n          \"active\": { \"type\": \"boolean\" },\n          \"hash_id\": { \"type\": \"string\" },\n          \"can\": {\n            \"type\": \"object\",\n            \"properties\": {\n              \"view\": { \"type\": \"boolean\" },\n              \"update\": { \"type\": \"boolean\" },\n              \"delete\": { \"type\": \"boolean\" },\n              \"activate\": { \"type\": \"boolean\" },\n              \"pause\": { \"type\": \"boolean\" }\n            }\n          },\n          \"team\": {\n            \"type\": \"object\",\n            \"properties\": {\n              \"id\": { \"type\": \"integer\" },\n              \"user_id\": { \"type\": \"integer\" },\n              \"name\": { \"type\": \"string\" },\n              \"personal_team\": { \"type\": \"boolean\" },\n              \"created_at\": { \"type\": \"string\" },\n              \"updated_at\": { \"type\": \"string\" }\n            }\n          }\n        }\n      }\n    },\n    \"can\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"viewAny\": { \"type\": \"boolean\" },\n        \"create\": { \"type\": \"boolean\" }\n      }\n    },\n    \"links\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"first\": { \"type\": \"string\" },\n        \"last\": { \"type\": \"string\" },\n        \"prev\": { \"type\": [\"string\", \"null\"] },\n        \"next\": { \"type\": [\"string\", \"null\"] }\n      }\n    },\n    \"meta\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"current_page\": { \"type\": \"integer\" },\n        \"from\": { \"type\": \"integer\" },\n        \"last_page\": { \"type\": \"integer\" },\n        \"links\": {\n          \"type\": \"array\",\n          \"items\": {\n            \"type\": \"object\",\n            \"properties\": {\n              \"url\": { \"type\": [\"string\", \"null\"] },\n              \"label\": { \"type\": \"string\" },\n              \"active\": { \"type\": \"boolean\" }\n            }\n          }\n        },\n        \"path\": { \"type\": \"string\" },\n        \"per_page\": { \"type\": \"integer\" },\n        \"to\": { \"type\": \"integer\" },\n        \"total\": { \"type\": \"integer\" }\n      }\n    }\n  }\n}\n\n

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"4effa175-9d3e-4868-b041-3606c34bdb8c","id":"4effa175-9d3e-4868-b041-3606c34bdb8c","name":"Gamifier","type":"collection"}},"urlObject":{"protocol":"{{Scheme}}","path":["api","v{{ApiVersion}}","applications"],"host":["{{Hostname}}"],"query":[],"variable":[]}},"response":[{"id":"dd4a757a-a756-4b1a-97dd-fba73ad6de9e","name":"Success","originalRequest":{"method":"GET","header":[],"url":"{{Scheme}}://{{Hostname}}/api/v{{ApiVersion}}/applications"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.4.1"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Wed, 25 Dec 2024 05:20:15 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"applications\": {\n \"data\": [\n {\n \"name\": \"Tesla Stats\",\n \"activated_at\": null,\n \"created_at\": \"2024-12-25T05:19:44.000000Z\",\n \"updated_at\": \"2024-12-25T05:19:44.000000Z\",\n \"active\": false,\n \"hash_id\": \"y8or9LAzYM\",\n \"can\": {\n \"view\": true,\n \"update\": true,\n \"delete\": true,\n \"activate\": true,\n \"pause\": true\n },\n \"team\": {\n \"id\": 1,\n \"user_id\": 1,\n \"name\": \"Mathew's Team\",\n \"personal_team\": true,\n \"created_at\": \"2024-12-14T09:20:48.000000Z\",\n \"updated_at\": \"2024-12-14T09:20:48.000000Z\"\n }\n }\n ],\n \"can\": {\n \"viewAny\": true,\n \"create\": true\n },\n \"links\": {\n \"first\": \"http://localhost/api/v1/applications?page=1\",\n \"last\": \"http://localhost/api/v1/applications?page=1\",\n \"prev\": null,\n \"next\": null\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"last_page\": 1,\n \"links\": [\n {\n \"url\": null,\n \"label\": \"« Previous\",\n \"active\": false\n },\n {\n \"url\": \"http://localhost/api/v1/applications?page=1\",\n \"label\": \"1\",\n \"active\": true\n },\n {\n \"url\": null,\n \"label\": \"Next »\",\n \"active\": false\n }\n ],\n \"path\": \"http://localhost/api/v1/applications\",\n \"per_page\": 15,\n \"to\": 1,\n \"total\": 1\n }\n }\n}"}],"_postman_id":"019294b0-933a-4345-8aa3-3c34b94d18e4"},{"name":"Get Application","id":"d076fbf5-1f4d-4d7c-b80a-2ebb38001be7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{Scheme}}://{{Hostname}}/api/v{{ApiVersion}}/applications/{{ApplicationID}}","description":"

Retrieve Application Details

This endpoint retrieves details of a specific application.

Request

Method: GET
\n
URL: {{Scheme}}://{{Hostname}}/api/v{{ApiVersion}}/applications/{{ApplicationID}}
\n

Response

The response for this request is a JSON object with the following schema:

{\n    \"type\": \"object\",\n    \"properties\": {\n        \"team_id\": { \"type\": \"integer\" },\n        \"name\": { \"type\": \"string\" },\n        \"activated_at\": { \"type\": [\"string\", \"null\"] },\n        \"created_at\": { \"type\": \"string\" },\n        \"updated_at\": { \"type\": \"string\" },\n        \"active\": { \"type\": \"boolean\" },\n        \"hash_id\": { \"type\": \"string\" },\n        \"can\": {\n            \"type\": \"object\",\n            \"properties\": {\n                \"view\": { \"type\": \"boolean\" },\n                \"update\": { \"type\": \"boolean\" },\n                \"delete\": { \"type\": \"boolean\" },\n                \"activate\": { \"type\": \"boolean\" },\n                \"pause\": { \"type\": \"boolean\" }\n            }\n        }\n    }\n}\n\n

Create Application

This endpoint allows you to create a new application.

Request Body

name (text): The name of the application.

Response

The response will be in the form of a JSON object with the following properties:

team_id (number): The ID of the team associated with the application.
\n
name (string): The name of the application.
\n
activated_at (string, null): The date and time when the application was activated, or null if not activated.
\n
created_at (string): The date and time when the application was created.
\n
updated_at (string): The date and time when the application was last updated.
\n
hash_id (string): The unique hash ID of the application.
\n
can (object): An object containing boolean properties for various actions such as view, update, delete, activate, and pause.
\n

JSON Schema for Response

{\n    \"type\": \"object\",\n    \"properties\": {\n        \"team_id\": { \"type\": \"number\" },\n        \"name\": { \"type\": \"string\" },\n        \"activated_at\": { \"type\": [\"string\", \"null\"] },\n        \"created_at\": { \"type\": \"string\" },\n        \"updated_at\": { \"type\": \"string\" },\n        \"hash_id\": { \"type\": \"string\" },\n        \"can\": {\n            \"type\": \"object\",\n            \"properties\": {\n                \"view\": { \"type\": \"boolean\" },\n                \"update\": { \"type\": \"boolean\" },\n                \"delete\": { \"type\": \"boolean\" },\n                \"activate\": { \"type\": \"boolean\" },\n                \"pause\": { \"type\": \"boolean\" }\n            }\n        }\n    }\n}\n\n

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"4effa175-9d3e-4868-b041-3606c34bdb8c","id":"4effa175-9d3e-4868-b041-3606c34bdb8c","name":"Gamifier","type":"collection"}},"urlObject":{"protocol":"{{Scheme}}","path":["api","v{{ApiVersion}}","applications"],"host":["{{Hostname}}"],"query":[],"variable":[]}},"response":[{"id":"ca42daf5-1b4e-495e-82c0-405b638dd4c5","name":"Error","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"name","value":"Tesla Stats","type":"text"}]},"url":"{{Scheme}}://{{Hostname}}/api/v{{ApiVersion}}/applications"},"status":"Unprocessable Content","code":422,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.4.1"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Wed, 25 Dec 2024 02:33:19 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"The name has already been taken.\",\n \"errors\": {\n \"name\": [\n \"The name has already been taken.\"\n ]\n }\n}"},{"id":"fb7aa356-cd14-4ce2-bba7-eb4941432ac2","name":"Succes","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text","disabled":true}],"body":{"mode":"formdata","formdata":[{"key":"name","value":"Tesla Stats","type":"text"}]},"url":"{{Scheme}}://{{Hostname}}/api/v{{ApiVersion}}/applications"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.4.1"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Wed, 25 Dec 2024 05:19:44 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"application\": {\n \"name\": \"Tesla Stats\",\n \"updated_at\": \"2024-12-25T05:19:44.000000Z\",\n \"created_at\": \"2024-12-25T05:19:44.000000Z\",\n \"active\": false,\n \"hash_id\": \"y8or9LAzYM\",\n \"team\": {\n \"id\": 1,\n \"user_id\": 1,\n \"name\": \"Mathew's Team\",\n \"personal_team\": true,\n \"created_at\": \"2024-12-14T09:20:48.000000Z\",\n \"updated_at\": \"2024-12-14T09:20:48.000000Z\"\n }\n }\n}"}],"_postman_id":"ae246d65-2ada-4f6d-afcb-b47ae2ca20dc"},{"name":"Update Application","id":"6ab08313-d934-4934-a130-eccb24b154b2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"FlashView.link\"\n}","options":{"raw":{"language":"json"}}},"url":"{{Scheme}}://{{Hostname}}/api/v{{ApiVersion}}/applications/{{ApplicationID}}","description":"

Update Application Details

This endpoint allows the client to update the details of a specific application.

Request Body

Type: JSON
\n
{ \"name\": \"string\" // The new name of the application }
\n

Response

The response is a JSON object with the following properties:

team_id (number): The ID of the team associated with the application.
\n
name (string): The name of the application.
\n
activated_at (string or null): Timestamp of when the application was activated.
\n
created_at (string): Timestamp of when the application was created.
\n
updated_at (string): Timestamp of when the application was last updated.
\n
active (boolean): Indicates if the application is active.
\n
hash_id (string): Unique hash ID of the application.
\n
can (object): Object containing boolean properties for various actions such as view, update, delete, activate, and pause.
\n

JSON Schema for Response

{\n    \"type\": \"object\",\n    \"properties\": {\n        \"team_id\": { \"type\": \"number\" },\n        \"name\": { \"type\": \"string\" },\n        \"activated_at\": { \"type\": [\"string\", \"null\"] },\n        \"created_at\": { \"type\": \"string\" },\n        \"updated_at\": { \"type\": \"string\" },\n        \"active\": { \"type\": \"boolean\" },\n        \"hash_id\": { \"type\": \"string\" },\n        \"can\": {\n            \"type\": \"object\",\n            \"properties\": {\n                \"view\": { \"type\": \"boolean\" },\n                \"update\": { \"type\": \"boolean\" },\n                \"delete\": { \"type\": \"boolean\" },\n                \"activate\": { \"type\": \"boolean\" },\n                \"pause\": { \"type\": \"boolean\" }\n            },\n            \"required\": [\"view\", \"update\", \"delete\", \"activate\", \"pause\"]\n        }\n    },\n    \"required\": [\"team_id\", \"name\", \"created_at\", \"updated_at\", \"active\", \"hash_id\", \"can\"]\n}\n\n

Activate Application

This endpoint is used to activate a specific application.

Request Body

No request body is required for this endpoint.

Response

{\n    \"name\": \"string\",\n    \"activated_at\": \"string\",\n    \"created_at\": \"string\",\n    \"updated_at\": \"string\",\n    \"active\": true,\n    \"hash_id\": \"string\",\n    \"can\": {\n        \"view\": true,\n        \"update\": true,\n        \"delete\": true,\n        \"activate\": true,\n        \"pause\": true\n    }\n}\n\n

PATCH /api/v{{ApiVersion}}/applications/{{ApplicationID}}/pause

This endpoint is used to pause a specific application.

Request

The request body should contain the necessary parameters to pause the application.

Response

The response will be a JSON object with the following schema:

{\n    \"team_id\": 0,\n    \"name\": \"\",\n    \"activated_at\": null,\n    \"created_at\": \"\",\n    \"updated_at\": \"\",\n    \"active\": true,\n    \"hash_id\": \"\",\n    \"can\": {\n        \"view\": true,\n        \"update\": true,\n        \"delete\": true,\n        \"activate\": true,\n        \"pause\": true\n    }\n}\n\n

The response contains information about the application, including its activation status, creation and update timestamps, and permissions for various actions.

This endpoint sends an HTTP DELETE request to delete a specific application identified by the ApplicationID in the URL.

Response

The response for this request is expected to be null.

JSON Schema

{\n  \"type\": \"null\"\n}\n\n

Applications represent your applicaiton within Gamify.

\n","_postman_id":"1ef45089-ba9b-4dd8-a5b8-df6692f2c835","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"4effa175-9d3e-4868-b041-3606c34bdb8c","id":"4effa175-9d3e-4868-b041-3606c34bdb8c","name":"Gamifier","type":"collection"}}},{"name":"Actions","item":[{"name":"List Actions","id":"40de07a7-6103-48f6-a805-561ee0969947","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{Scheme}}://{{Hostname}}/api/v{{ApiVersion}}/applications/{{ApplicationID}}/actions","description":"

GET /api/v{{ApiVersion}}/applications/{{ApplicationID}}/actions

This endpoint retrieves the actions associated with a specific application.

Request

No request body is required for this endpoint.

Path Parameters
\n
- ApiVersion (number) - The version of the API.
  \n
- ApplicationID (string) - The unique identifier of the application.
  \n
\n

Response

The response for this request is a JSON object representing the actions and application details. It includes the following properties:

actions (object) - An object containing the list of actions associated with the application, along with metadata.
\n
- data (array) - An array of objects representing individual actions, including their name, description, points, timestamps, and permissions.
  \n
- can (object) - An object indicating the user's permissions to view and create actions.
  \n
- links (object) - An object containing links to navigate through the list of actions.
  \n
- meta (object) - An object providing metadata about the actions, such as the current page, total count, and pagination links.
  \n
\n
application (object) - An object representing the application details, including its name, timestamps, activation status, and permissions.
\n

The JSON schema for the response can be referred to for detailed information about the structure of the response.

{\n    \"type\": \"object\",\n    \"properties\": {\n        \"actions\": {\n            \"type\": \"object\",\n            \"properties\": {\n                ...\n            }\n        },\n        \"application\": {\n            \"type\": \"object\",\n            \"properties\": {\n                ...\n            }\n        }\n    }\n}\n\n

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"4effa175-9d3e-4868-b041-3606c34bdb8c","id":"4effa175-9d3e-4868-b041-3606c34bdb8c","name":"Gamifier","type":"collection"}},"urlObject":{"protocol":"{{Scheme}}","path":["api","v{{ApiVersion}}","applications","{{ApplicationID}}","actions"],"host":["{{Hostname}}"],"query":[],"variable":[]}},"response":[{"id":"757c9bf4-5e04-4ada-a2cc-592a51908aee","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text","disabled":true}],"url":"{{Scheme}}://{{Hostname}}/api/v{{ApiVersion}}/applications/{{ApplicationID}}/actions"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.4.1"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Wed, 25 Dec 2024 05:40:33 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"actions\": {\n \"data\": [\n {\n \"name\": \"Send long expiry message\",\n \"description\": null,\n \"points\": 90,\n \"created_at\": \"2024-12-25T05:39:22.000000Z\",\n \"updated_at\": \"2024-12-25T05:39:22.000000Z\",\n \"hash_id\": \"x6OzEPaVbM\",\n \"can\": {\n \"view\": true,\n \"update\": true,\n \"delete\": true\n },\n \"application\": {\n \"name\": \"Tesla Stats\",\n \"activated_at\": null,\n \"created_at\": \"2024-12-25T05:26:15.000000Z\",\n \"updated_at\": \"2024-12-25T05:26:15.000000Z\",\n \"active\": false,\n \"hash_id\": \"vnAzO4mr7V\",\n \"can\": {\n \"view\": true,\n \"update\": true,\n \"delete\": true,\n \"activate\": true,\n \"pause\": true\n }\n }\n }\n ],\n \"can\": {\n \"viewAny\": true,\n \"create\": true\n },\n \"links\": {\n \"first\": \"http://localhost/api/v1/applications/vnAzO4mr7V/actions?page=1\",\n \"last\": \"http://localhost/api/v1/applications/vnAzO4mr7V/actions?page=1\",\n \"prev\": null,\n \"next\": null\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"last_page\": 1,\n \"links\": [\n {\n \"url\": null,\n \"label\": \"« Previous\",\n \"active\": false\n },\n {\n \"url\": \"http://localhost/api/v1/applications/vnAzO4mr7V/actions?page=1\",\n \"label\": \"1\",\n \"active\": true\n },\n {\n \"url\": null,\n \"label\": \"Next »\",\n \"active\": false\n }\n ],\n \"path\": \"http://localhost/api/v1/applications/vnAzO4mr7V/actions\",\n \"per_page\": 15,\n \"to\": 1,\n \"total\": 1\n }\n },\n \"application\": {\n \"name\": \"Tesla Stats\",\n \"activated_at\": null,\n \"created_at\": \"2024-12-25T05:26:15.000000Z\",\n \"updated_at\": \"2024-12-25T05:26:15.000000Z\",\n \"active\": false,\n \"hash_id\": \"vnAzO4mr7V\",\n \"can\": {\n \"view\": true,\n \"update\": true,\n \"delete\": true,\n \"activate\": true,\n \"pause\": true\n }\n }\n}"}],"_postman_id":"40de07a7-6103-48f6-a805-561ee0969947"},{"name":"Get Action","id":"65cc661d-afd6-47e2-a08d-de3867e66f9e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{Scheme}}://{{Hostname}}/api/v{{ApiVersion}}/applications/{{ApplicationID}}/actions/{{ActionId}}","description":"

Retrieve Application Action Details

This endpoint retrieves details of a specific action within an application.

Request

Method: GET
\n
URL: {{Scheme}}://{{Hostname}}/api/v{{ApiVersion}}/applications/{{ApplicationID}}/actions/{{ActionId}}
\n

Request Body

This request does not require a request body.

Response

The response for this request is a JSON object with the following schema:

{\n    \"action\": {\n        \"name\": { \"type\": \"string\" },\n        \"description\": { \"type\": [\"string\", \"null\"] },\n        \"points\": { \"type\": \"integer\" },\n        \"created_at\": { \"type\": \"string\" },\n        \"updated_at\": { \"type\": \"string\" },\n        \"hash_id\": { \"type\": \"string\" },\n        \"can\": {\n            \"view\": { \"type\": \"boolean\" },\n            \"update\": { \"type\": \"boolean\" },\n            \"delete\": { \"type\": \"boolean\" }\n        },\n        \"application\": {\n            \"name\": { \"type\": \"string\" },\n            \"activated_at\": { \"type\": [\"string\", \"null\"] },\n            \"created_at\": { \"type\": \"string\" },\n            \"updated_at\": { \"type\": \"string\" },\n            \"active\": { \"type\": \"boolean\" },\n            \"hash_id\": { \"type\": \"string\" },\n            \"can\": {\n                \"view\": { \"type\": \"boolean\" },\n                \"update\": { \"type\": \"boolean\" },\n                \"delete\": { \"type\": \"boolean\" },\n                \"activate\": { \"type\": \"boolean\" },\n                \"pause\": { \"type\": \"boolean\" }\n            }\n        }\n    }\n}\n\n

Can be any integer. Negative values allowed.

\n","type":"text"},{"key":"description","value":"Represents sending a message that expires longer than 7 days","description":"

Optional

\n","type":"text"}]},"url":"{{Scheme}}://{{Hostname}}/api/v{{ApiVersion}}/applications/{{ApplicationID}}/actions","description":"

Create Application Action

This endpoint is used to create a new action for a specific application.

Request Body

name (text): The name of the action.
\n
points (text): Can be any integer. Negative values allowed.
\n
description (text): Optional description of the action.
\n

Response

The response will be in the form of a JSON object with the following properties:

action (object): An object containing details of the created action including name, description, points, updated_at, created_at, hash_id, and application details.

JSON Schema for Response

{\n    \"type\": \"object\",\n    \"properties\": {\n        \"action\": {\n            \"type\": \"object\",\n            \"properties\": {\n                \"name\": { \"type\": \"string\" },\n                \"description\": { \"type\": \"string\" },\n                \"points\": { \"type\": \"string\" },\n                \"updated_at\": { \"type\": \"string\" },\n                \"created_at\": { \"type\": \"string\" },\n                \"hash_id\": { \"type\": \"string\" },\n                \"application\": {\n                    \"type\": \"object\",\n                    \"properties\": {\n                        \"name\": { \"type\": \"string\" },\n                        \"activated_at\": { \"type\": [\"string\", \"null\"] },\n                        \"created_at\": { \"type\": \"string\" },\n                        \"updated_at\": { \"type\": \"string\" },\n                        \"active\": { \"type\": \"boolean\" },\n                        \"hash_id\": { \"type\": \"string\" },\n                        \"can\": {\n                            \"type\": \"object\",\n                            \"properties\": {\n                                \"view\": { \"type\": \"boolean\" },\n                                \"update\": { \"type\": \"boolean\" },\n                                \"delete\": { \"type\": \"boolean\" },\n                                \"activate\": { \"type\": \"boolean\" },\n                                \"pause\": { \"type\": \"boolean\" }\n                            }\n                        }\n                    }\n                }\n            }\n        }\n    }\n}\n\n

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"4effa175-9d3e-4868-b041-3606c34bdb8c","id":"4effa175-9d3e-4868-b041-3606c34bdb8c","name":"Gamifier","type":"collection"}},"urlObject":{"protocol":"{{Scheme}}","path":["api","v{{ApiVersion}}","applications","{{ApplicationID}}","actions"],"host":["{{Hostname}}"],"query":[],"variable":[]}},"response":[{"id":"e08047f7-d44b-46ce-8fb4-456cde0babe9","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"name","value":"Send long expiry message","type":"text"},{"key":"points","value":"90","type":"text"}]},"url":"{{Scheme}}://{{Hostname}}/api/v{{ApiVersion}}/applications/{{ApplicationID}}/actions"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.4.1"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Wed, 25 Dec 2024 05:39:22 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"action\": {\n \"name\": \"Send long expiry message\",\n \"points\": \"90\",\n \"updated_at\": \"2024-12-25T05:39:22.000000Z\",\n \"created_at\": \"2024-12-25T05:39:22.000000Z\",\n \"hash_id\": \"x6OzEPaVbM\",\n \"application\": {\n \"name\": \"Tesla Stats\",\n \"activated_at\": null,\n \"created_at\": \"2024-12-25T05:26:15.000000Z\",\n \"updated_at\": \"2024-12-25T05:26:15.000000Z\",\n \"active\": false,\n \"hash_id\": \"vnAzO4mr7V\",\n \"can\": {\n \"view\": true,\n \"update\": true,\n \"delete\": true,\n \"activate\": true,\n \"pause\": true\n }\n }\n }\n}"},{"id":"db5cc87b-b072-4f7a-ae86-993e9c87320b","name":"Error","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"name","value":"Send long expiry message","type":"text"},{"key":"points","value":"90","type":"text","disabled":true}]},"url":"{{Scheme}}://{{Hostname}}/api/v{{ApiVersion}}/applications/{{ApplicationID}}/actions"},"status":"Unprocessable Content","code":422,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.4.1"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Wed, 25 Dec 2024 05:39:48 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"The name has already been taken. (and 1 more error)\",\n \"errors\": {\n \"name\": [\n \"The name has already been taken.\"\n ],\n \"points\": [\n \"The points field is required.\"\n ]\n }\n}"}],"_postman_id":"17c137af-a25e-4c99-9910-f18be0a46e0a"},{"name":"Update Application","id":"f0ce19fe-8fd8-4d9e-9dd0-45469d3edf37","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"points\": 30\n}","options":{"raw":{"language":"json"}}},"url":"{{Scheme}}://{{Hostname}}/api/v{{ApiVersion}}/applications/{{ApplicationID}}/actions/{{ActionId}}","description":"

Update Application Action

This endpoint is used to update a specific action within an application.

Request Body

Type: JSON
\n
Description: Payload containing the updated points, name and description for the action.
\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Description
points	number	The new points for the action
name	string
description	string

Response

The response is a JSON object with the following properties:

action (object): Object containing the details of the updated action.
\n
- name (string): The name of the action.
  \n
- description (string): The description of the action.
  \n
- points (number): The updated points for the action.
  \n
- created_at (string): Timestamp of when the action was created.
  \n
- updated_at (string): Timestamp of when the action was last updated.
  \n
- hash_id (string): Unique hash ID of the action.
  \n
- can (object): Object containing boolean properties for various actions such as view, update, and delete.
  \n
- application (object): Object containing the details of the associated application.
  \n
  - name (string): The name of the associated application.
    \n
  - activated_at (string or null): Timestamp of when the application was activated.
    \n
  - created_at (string): Timestamp of when the application was created.
    \n
  - updated_at (string): Timestamp of when the application was last updated.
    \n
  - active (boolean): Indicates if the application is active.
    \n
  - hash_id (string): Unique hash ID of the application.
    \n
  - can (object): Object containing boolean properties for various actions such as view, update, delete, activate, and pause.
    \n
  \n
\n

JSON Schema for Response

{\n    \"type\": \"object\",\n    \"properties\": {\n        \"action\": {\n            \"type\": \"object\",\n            \"properties\": {\n                \"name\": { \"type\": \"string\" },\n                \"description\": { \"type\": \"string\" },\n                \"points\": { \"type\": \"number\" },\n                \"created_at\": { \"type\": \"string\" },\n                \"updated_at\": { \"type\": \"string\" },\n                \"hash_id\": { \"type\": \"string\" },\n                \"can\": {\n                    \"type\": \"object\",\n                    \"properties\": {\n                        \"view\": { \"type\": \"boolean\" },\n                        \"update\": { \"type\": \"boolean\" },\n                        \"delete\": { \"type\": \"boolean\" }\n                    },\n                    \"required\": [\"view\", \"update\", \"delete\"]\n                },\n                \"application\": {\n                    \"type\": \"object\",\n                    \"properties\": {\n                        \"name\": { \"type\": \"string\" },\n                        \"activated_at\": { \"type\": [\"string\", \"null\"] },\n                        \"created_at\": { \"type\": \"string\" },\n                        \"updated_at\": { \"type\": \"string\" },\n                        \"active\": { \"type\": \"boolean\" },\n                        \"hash_id\": { \"type\": \"string\" },\n                        \"can\": {\n                            \"type\": \"object\",\n                            \"properties\": {\n                                \"view\": { \"type\": \"boolean\" },\n                                \"update\": { \"type\": \"boolean\" },\n                                \"delete\": { \"type\": \"boolean\" },\n                                \"activate\": { \"type\": \"boolean\" },\n                                \"pause\": { \"type\": \"boolean\" }\n                            },\n                            \"required\": [\"view\", \"update\", \"delete\", \"activate\", \"pause\"]\n                        }\n                    },\n                    \"required\": [\"name\", \"created_at\", \"updated_at\", \"active\", \"hash_id\", \"can\"]\n                }\n            },\n            \"required\": [\"name\", \"description\", \"points\", \"created_at\", \"updated_at\", \"hash_id\", \"can\", \"application\"]\n        }\n    },\n    \"required\": [\"action\"]\n}\n\n

This endpoint sends an HTTP DELETE request to delete a specific application identified by the ApplicationID in the URL.

Response

The response for this request is expected to be null.

JSON Schema

{\n  \"type\": \"null\"\n}\n\n

Actions represent any action done by a user of the application

\n","_postman_id":"c90f92a3-1036-44e1-902f-d7f9f4fe9d15","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"4effa175-9d3e-4868-b041-3606c34bdb8c","id":"4effa175-9d3e-4868-b041-3606c34bdb8c","name":"Gamifier","type":"collection"}}}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]}},"event":[{"listen":"prerequest","script":{"id":"af1cea12-facb-4f99-a97e-1a2647a7641f","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"6204fbb8-7b03-42a0-ba18-d6436e299e6e","type":"text/javascript","packages":{},"exec":[""]}}]}