1. Stubs
  2. Contact Lists

Stubs

Contact Lists

Overview

Contact lists are the central groupings of contacts on a stub and are used for a variety of purposes, such as lookups, record-keeping, and controlling access to actions and blocks on the stub.

Creating a contact list

Contact lists can be created on a flow, in which case the list is shared between all stubs of that flow, or contact lists can be added through a task or through the stub's UI, in which case the list is contained within that stub.

Data structure

loading...

Parameters

details.title

required
string

The contact list's title.


details.description

description

The contact list's description.


details.max_members

number

If set, this limits the maximum number of contacts that can be added to the list.


details.contact_type_filter

array

If set, this restricts the members of the list to contacts of the included types.


contactuuids

array

The uuids of the contacts included as members of the list.

Universal contact lists

The following contact lists are common among all stubs.

created_by

Contains the contact of the user who created the stub.


system

Contains system contacts used by built-in Stubber functionality.


shared

Contains contacts the stub has been shared with.


public


stubberauthenticated


assigned_to

List used by the assign_to task.