Save Form View

PUT

/forms/views/saved/{view_id}

• Production
• QA

Create or replace a saved view. PUT because it is an upsert by id.

Authorizations

• BearerAuth

Parameters

Path Parameters

view_id

required

The view’s id. Created when it does not exist.

string

The view’s id. Created when it does not exist.

Header Parameters

X-Target-Org-Id

Any of:

string

string

null

null

Request Body ^required

A named inventory filter set. Mirrors SavedFormsViewRequest.

object

filters

required

The inventory filter set a saved view stores. Mirrors PaginationRequest.

object

activity_end

Any of:

string

string format: date-time

null

null

activity_start

Any of:

string

string format: date-time

null

null

capture_health

Any of:

string

string

Allowed values: healthy no_data

null

null

delivery_state

Any of:

string

string

Allowed values: active paused failed not_configured

null

null

destination_list_id

Any of:

integer

integer

>= 1

null

null

has_failures

Any of:

boolean

boolean

null

null

has_new_fields

Any of:

boolean

boolean

null

null

identity_quality

Any of:

string

string

Allowed values: verified variant collision historic_uncertain

null

null

mapping_state

Any of:

string

string

Allowed values: mapped unmapped

null

null

owner_id

Any of:

string

string

<= 200 characters

null

null

page

integer

default: 1 >= 1

per_page

integer

default: 20 >= 1 <= 500

saved_view

Any of:

string

string

Allowed values: live needs_setup failing ignored healthy failures new_fields no_recent_submissions missing_or_collision destination_unavailable newly_discovered

null

null

search

Any of:

string

string

<= 200 characters

null

null

sort_field

Any of:

string

string

Allowed values: submissions_30d total_submissions latest_submitted_at form_tag_id

null

null

sort_order

Any of:

string

string

Allowed values: asc desc

null

null

source_id

Any of:

string

string

<= 500 characters

null

null

write_key

Any of:

string

string

null

null

name

required

string

>= 1 characters <= 100 characters

Responses

200

Successful Response

object

data

required

One forms object, or one handler response.

Open-shaped: the submission, mapping, group and audit payloads grow with the product, and a closed model here would silently drop what it does not name.

object

key

additional properties

any

pagination

Any of:

PaginationMeta

object

has_next

required

Whether there are more pages

boolean

limit

required

Items per page

integer

next_cursor

Any of:

string

string

null

null

notes

Any of:

Array<string>

Array<string>

null

null

page

required

Current page number (1-indexed)

integer

total

required

Total number of items

integer

total_available

Any of:

integer

integer

null

null

total_is_lower_bound

Any of:

boolean

boolean

null

null

null

null

422

Validation Error

object

detail

Array<object>

object

loc

required

Array

msg

required

string

type

required

string