Unicat API Reference

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

Requires JWT.

Rename a channel.

Request

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

{
    "channel": "650ebd0f-eab5-41d7-87c1-1dc5334af872",
    "name": "Documentation Channel"
}

Note: channel __all__ is not a "real" channel; it cannot be created, renamed, or moved; that includes trying to move other channels before __all__.

Success response

Authorization: <JWT>

{
    "success": true,
    "result": {
        "project": "<project gid>"
    },
    "data": {
        "cc.projects": {
            "<project gid>": {
                …,
                "options": {
                    "channels": {
                        "__all__": "[all records]",
                        "650ebd0f-eab5-41d7-87c1-1dc5334af872": "Documentation Channel"
                    },
                   …
                },
                …
            }
        }
    }
}

result

project the current project.

data

cc.projects Project updated with renamed channel.

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