Skip to main content
POST

Authorizations

Authorization
string
header
required

Pass Authorization: Bearer <credential>, where the credential is either:

  • an API key (sk_…), generated by an organization admin in Settings, for scripts and automation;
  • an access token from tth auth login (the TalkToHumans CLI), which any member of the workspace can use.

Both resolve to the same organization and user. A login token acts in the user's workspace: one with no workspace yet returns 403 workspace_setup_required, and one in several workspaces returns 403 forbidden (use an API key instead).

Body

application/json
name
string
required

Name shown in the sidebar, 2 to 4 plain words in sentence case, such as Event leads.

Required string length: 1 - 120
account_id
string

LinkedIn account ID returned by GET /v1/accounts. Required when the organization has multiple LinkedIn accounts.

Pattern: ^[1-9][0-9]*$
type
enum<string>
default:contact
Available options:
inbox,
contact,
company,
content
description
string | null
view_type
enum<string>

Layout of contact and company views. Inboxes are always table and content views always feed.

Available options:
table,
map,
feed
icon
string

Icon name, such as star, mail, or calendar. Defaults to the view type's icon. An unknown name fails with the list of icons.

icon_color
enum<string>

Color of the view's icon, from the tag colors. New views default to grey. Leave it out unless the view stands for one tag; then use that tag's color.

Available options:
green,
orange,
blue,
red,
purple,
yellow,
pink,
grey
position
integer

Place among the account's views of the same type in the sidebar, from 1 at the top. Hidden views count. Defaults to the bottom.

Required range: x >= 1
filters
object[]

Filters records must all match, one per field. New inboxes leave muted conversations out unless a filter uses is_muted, and leave archived conversations out when filters is omitted.

advanced_filters
object

Advanced filters, as the app's advanced filter builder saves them. Unlike filters, a field can appear in several rules.

sorts
object[]
group_by
string

Field to group conversations by, such as conversation.last_message_date. Inboxes only.

columns
string[]

Columns to show, left to right, as field keys such as member.full_name or member.custom_fields.<name>. Pick the 5 to 7 that answer the view's question. Contact and company views only. Defaults to the app's full set of columns, except for contact views filtered on engagement (member.signals, member.last_signal_at, or a post's member.ce_<content_id>), which get member.full_name, member.signals, member.headline, member.relationship_status, conversation.last_message_date and member.tags.

count_mode
enum<string>

Count shown next to an inbox in the sidebar.

Available options:
unread,
total
visibility_mode
enum<string>

When a view is shown in the sidebar. when_unread is for inboxes only.

Available options:
always,
when_unread,
when_not_empty
conversation_open_mode
enum<string>

Whether an inbox opens conversations full page or beside the list.

Available options:
full,
side_peek
is_hidden
boolean
default:false

Response

View created.

data
object
required