This API creates or updates an existing Gamification action. Read more about Gamification Actions.
us1.gigya.com- For the US data center.
eu1- For the European data center.
au1- For the Australian data center.
ru1- For the Russian data center.
cn1- For the Chinese data center.
If you are not sure of your site's data center, see Finding Your Data Center.
|||actionID||string||The unique ID of the action.|
|||title||string or JSON|
The name of the action. The name should be in the following format:
Note: This parameter is optional, but for the best practice implementation, we recommend adding an action name to each action.
|||points||integer||The number of points a user earns for performing this action.|
|||description||JSON||The description of the action. The description has the same format as the title parameter - it is constructed of the description in the default language, and also of a pair or pairs of language codes with their respective action descriptions:|
"default":"<action description in default language>",
The available language codes can be found here. The parameter can be passed as a string only, without the language codes, in which case the string represents the description of the action in the default language, e.g. "New user registration via Gigya social login".
|||freqCap||integer||The number of seconds that need to pass from the time a user performs this action before he can earn more points for performing this action again. The default value is "0".|
|||dailyCap||integer||The set amount of times a day that performing this action awards the user points. The default value is "0", which means there is no limit on the number of times the user can earn points for performing this action. Note: there is a technical limit, which currently stands on 1000.|
|||enabled||Boolean||Indicates whether the action is enabled or not. The default value is 'false'.|
|||triggerActionID||string||The ID of an action performed by a referred user that will trigger the current action and grant points to the referring user automatically.|
|||allowClientSideNotifyAction||Boolean||Indicates whether to allow client-side access to the API to allow updating of of this action. The default is 'false'. Setting this parameter to 'true' enables the usage of the gm.notifyAction API method from your client application. It is highly advised disabling client access and executing this method from your server so as to prevent hacking. You can find the server side API in REST API > gm.notifyAction. Note: the value of this parameter overrides the value of the identical parameter in gm.setGlobalConfig.|
Each REST API request must contain identification and authorization parameters.
Some REST APIs may function without these authorization parameters, however, when that occurs, these calls are treated as client-side calls and all client-side rate limits will apply. In order to not reach client-side IP rate limits that may impact your implementation when using server-to-server REST calls, it is Recommended Best Practice to always sign the request or use a secret. A non-exhaustive list of REST APIs that this may apply to are as follows:
Please refer to the Authorization Parameters section for details.