Skip to main content
POST
Make a view

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

idempotency-key
string

Any client-chosen key, a uuid for example. Sending the same request twice with the same key has one effect and returns the same response twice; the same key with a different body returns 409.

Required string length: 1 - 255
Example:

"3f1b2c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d"

Body

application/json
view
string

The view to change, by name or id from list_views. Leave it out to make a new one. A People view and a Companies view can share a name; then add the subject, as in "Your audience (companies)".

Required string length: 1 - 200
name
string

The name of the view in the sidebar. A new view needs it.

Required string length: 1 - 200
kind
enum<string>

New views only. filter keeps itself up to date: whoever matches is in it. hand_picked is a list you fill. Left out: filter when you give a filter, else hand_picked.

Available options:
filter,
hand_picked
filter
object

The filter in the words of get_filter_options. On a change it replaces the whole filter, so start from get_view.

icon
string | null

An icon key such as star or flame; null clears it.

Pattern: ^[a-z0-9-]{1,40}$
person_ids
string[]

New hand-picked views only: people to put in it right away.

Required array length: 1 - 500 elements
Pattern: ^\S{1,200}$
confirm_id
string

The confirm_id of a needs_confirmation answer: commits what that answer summarised.

Response

The result, or without confirm_id first a needs_confirmation answer: nothing happened yet.

view
object
required
app_url
string
required
effects
string[]

What this change does to the syncs of the view. Tell the user.