Unicat API Reference

/api/p/<project gid>/channels/create

Requires JWT.

Create a channel.

Request

POST /api/p/<project gid>/channels/create
Authorization: Bearer <JWT>

{
    "name": "New Channel Name"
}

Success response

Authorization: <JWT>

{
    "success": true,
    "result": {
        "channel": "23d17876-e3cb-4acf-8eeb-a0154ca83a75",
        "project": "<project gid>"
    },
    "data": {
        "cc.projects": {
            "<project gid>": {
                …,
                "options": {
                    "channels": {
                        "__all__": "[all records]",
                        "650ebd0f-eab5-41d7-87c1-1dc5334af872": "Website NL",
                        "23d17876-e3cb-4acf-8eeb-a0154ca83a75": "New Channel Name"
                    },
                    …,
                    "orderedchannels": [
                        "__all__",
                        "650ebd0f-eab5-41d7-87c1-1dc5334af872",
                        "23d17876-e3cb-4acf-8eeb-a0154ca83a75"
                    ],
                   …
                },
                …
            }
        }
    }
}

result

channel the key for the newly created channel.
project the current project.

data

cc.projects Project updated with new channels and orderedchannels options.

Error responses

400 Bad request - missing parameters or wrong type or value
401 Unauthorized - missing or expired JWT
403 Forbidden - not a member of this project