When creating or deploying a badge, point, content or chat one or more deployment options needs to be selected and configured. These determine the manner in which claiming of the deployed element on Awardable is handled. These deployment options are then provided within the deployment_options
array that are used in calls to the deploy
and create
endpoints.
Type/Options
Each deployment option has a unique type
value associated with it. On setting each deployment this type is set, and dictates the expected options that are passed along with it.
Based on the type
value that is provided, a range of options are expected along with it. These options are a series of key/value pairs that provide the context for claims to be handled and the specific settings of the deployment.
The combination of these provide an object that is added to the deployment_options
array such as:
{
"type": "type_name", //The string for the deployment option, such as native_supply
"option_a": "value_a", //The key value pair for a deployment option
"option_b": 123, //Options can contain a range of different types
}