Create User Message Definition

User Guide > Resources > Create User Message Definition

This request creates a user message definition.

Resource

POST /usermessagedefinitions

Parameters

Common Create Parameters

Payload

User Message Definition

Response

Object Response < User Message Definition >

Context

Authorization

Administrator

Errors

Common Errors

Example

Request
POST https://xelion.nl/api/v1/master/usermessagedefinitions
Payload
{
    "commonName": "testusermessagedefinition",
    "users": [
        {
            "user": {
                "commonName": "wes",
                "oid": "1651218",
                "objectType": "UserProfile"
            },
            "objectType": "relUserMessageDefUser"
        },
        {
            "user": {
                "commonName": "arno",
                "oid": "1651120",
                "objectType": "UserProfile"
            },
            "objectType": "relUserMessageDefUser"
        }
    ],
    "objectType": "UserMessageDefinition"
}
Response
{
    "object": {
        "users": [
            {
                "user": {
                    "permissions": "ReadWriteRemove",
                    "commonName": "wes",
                    "oid": "1651218",
                    "objectType": "UserProfile"
                },
                "oid": "1855615",
                "objectType": "relUserMessageDefUser"
            },
            {
                "user": {
                    "permissions": "ReadWriteRemove",
                    "commonName": "arno",
                    "oid": "1651120",
                    "objectType": "UserProfile"
                },
                "oid": "1855616",
                "objectType": "relUserMessageDefUser"
            }
        ],
        "permissions": "ReadWriteRemove",
        "commonName": "testusermessagedefinition",
        "oid": "1855613",
        "objectType": "UserMessageDefinition"
    },
    "links": [
        {
            "rel": "self",
            "href": "https://xelion.nl/api/v1/master/usermessagedefinitions/1855613",
            "method": "GET"
        }
    ]
}