Skip to main content
POST
Create a custom view

Authorizations

Authorization
string
header
required

The id_token from POST /auth/v1/signin, sent as Authorization: Bearer <id_token>. Not the access_token — that one does not carry the identity Cloud Chat authorizes on.

Headers

cloudchat-instance
integer
required

Your Cloud Chat instance ID — an integer, fixed for your company, told at onboarding. The API overview explains how instances work, how to find yours, and the errors a wrong or missing value produces.

Example:

1

Path Parameters

accountId
integer
required

Your Cloud Chat account. It has to be an account your token grants membership on, and it has to live on the instance in the cloudchat-instance header — the two travel together. Account numbers are only unique within an instance, so the same number is a different company on another instance. Usually a mismatched pair fails closed with a 401, because your user does not exist on the other instance — but if your identity happens to exist on both, the call succeeds against the other company's data, silently. Read it and you are looking at the wrong help center; write it and you have stored into the wrong account. Send the two values that were given to you together, and never try a number to see what answers.

Example:

1

Body

application/json

The view goes under a custom_view wrapper. The owner is the caller.

custom_view
object
required

Response

Created. The body is the view itself, not wrapped in data.

A saved filter of conversations or contacts, kept in the dashboard sidebar.

id
integer
required
Example:

14

name
string
required
Example:

"Open and unassigned"

filter_type
enum<string>
required

What the view filters: conversation for a folder, contact for a segment.

Available options:
conversation,
contact
Example:

"conversation"

visibility
enum<string>
required

private is visible only to its owner, public to everyone in the account, team to the members of the teams in team_ids.

Available options:
private,
public,
team
Example:

"private"

team_ids
integer[]
required

Ids of the teams the view is shared with. Empty unless visibility is team.

Example:
query
object
required

The saved filter. Normally { "payload": [...] } with the conditions described on CustomViewCondition; views saved by older versions of the dashboard may carry other keys, which are returned as stored.

Example:
owned_by_me
boolean
required

true when you own the view. Only those can be changed or deleted.

Example:

true

created_at
string<date-time>
required
Example:

"2026-11-02T11:04:17.000Z"

updated_at
string<date-time>
required
Example:

"2026-11-05T14:32:05.123Z"