How to: Define Participant Attributes

For information about prerequisites, see Creating Participants.

To add the Attributes to a Participant type, call the Update Participant Attribute endpoint.

The following sample request body only defines a couple of custom Attributes such as type, model, imei number, and org_owned to a mobiledevice Participant.

{  
    "attributes": [  
        {  
            "name": "type",  
            "description": "Device Type",  
            "dataType": "string",  
            "defaultValue": "SmartPhone",  
            "indexed": true,  
            "required": true  
        },  
        {  
            "name": "model",  
            "description": "Model Number",  
            "dataType": "string",  
            "indexed": true,  
            "validation": {  
                "required": false  
            }  
        },  
        {  
            "name": "imei",  
            "description": "IMEI Number",  
            "dataType": "string",  
            "indexed": true,  
            "validation": {  
                "required": false  
            }  
        },  
        {  
            "name": "org_owned",  
            "description": "Owned by organization",  
            "dataType": "boolean",  
            "indexed": true,  
            "defaultValue": false,  
            "validation": {  
                "required": false  
            }  
        }  
    ],  
    "callback": "{{callback_url}}"  
}

Did this page help you?