How to: Define Participant Attributes

1min
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.
JSON
{
    "attributes": [
        {
            "name": "deviceType",
            "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": "orgOwned",
            "description": "Owned by organization",
            "dataType": "boolean",
            "indexed": true,
            "defaultValue": false,
            "validation": {
                "required": false
            }
        }
    ],
    "callback": {
         "url": "https://www.examplecallback.com",
        "meta": {
            "key1": "Post ptp type"
        }
    }
}_
{
    "attributes": [
        {
            "name": "deviceType",
            "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": "orgOwned",
            "description": "Owned by organization",
            "dataType": "boolean",
            "indexed": true,
            "defaultValue": false,
            "validation": {
                "required": false
            }
        }
    ],
    "callback": {
         "url": "https://www.examplecallback.com",
        "meta": {
            "key1": "Post ptp type"
        }
    }
}_
﻿
﻿
Updated 14 Aug 2023
Did this page help you?
Update Attributes and State with a Single API
How to: Create a Participant Template