create view

post

https://{defaultHost}/views

A published view must be filed into at least one collection

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

name

string

required

The name of the view. The slug is derived from it.

layout

string

required

The canvas to build the view on. Must be one of the canvases enabled for the workspace: <TopicType>Group for a group-only canvas, or <TopicType>Group__FactCard::<TopicType> for an extended canvas that also renders Fact Cards.

user_id

integer

The member the view is created on behalf of. They author its first version and become its manager. Required when authenticating with an API key; OAuth tokens default to the authorising user.

definition

string

required

What the view is for. Required.

featured

boolean

Whether to highlight the view in the app

visibility

string

enum

Defaults to draft, which keeps the view private to its manager. published makes it visible to the whole organisation and requires at least one collection. Sharing with specific members or teams is done in the app.

Allowed:

view_collection_ids

array of uuids

The collections to file the view under. Required when publishing.

view_collection_ids

Responses

201published view created

401Unauthorized

422validation failed