1. Tasks
  2. Add Contact List

Tasks

Add Contact List

The Add Contact List task creates a new contact list on the stub.

Each stub can have multiple contact lists.
Contact lists are used to manage the different groups of people, systems, or groups that are involved in the stub.
Contact Lists can be used to set pointers for responsibility and accountability on the stub, such as the assigned to pointer.

Basic usage

loading...

Parameters

title

required
string

This is the title of the list as it will appear on the stub


list_name

optional
string

This is name that can be used to refer to the list in subsequent tasks and actions

Default: snake case and lowercase of the title


description

optional
string

Describe what the list is for and who is supposed to be in it.


contact_type_filter

optional
array

Restrict the contact types of the contacts that can be in this list.

Options: individual group system


max_members

optional
integer

Limit how many contacts can be in a list.


hidden

optional
boolean

Hides the contact list on the stub.


hide_if_empty

optional
boolean

Hides the contact list on the stub if the contact list doesn't contain any contacts


allowed_stub_actions.add_contact

optional
boolean

Makes the add_contact action available for the contact list.


allowed_stub_actions.remove_contact

optional
boolean

Makes the remove_contact action available for the contact list.


allowed_stub_actions.remove_contact

optional
boolean

Makes the remove_contact action available for the contact list.


allowed_stub_actions.assign_to

optional
boolean

Makes the assign_to action available for the contact list.


allowed_stub_actions.set_overseen_by

optional
boolean

Makes the set_overseen_by action available for the contact list.


allowed_stub_actions.set_in_the_pool_of

optional
boolean

Makes the set_in_the_pool_of action available for the contact list.

Result

loading...

Properties

list_name

string

The list_name of the newly created contact list.

Examples

These are some more complex examples

Different list_name

loading...

Include description

loading...

With contact type filter

loading...

With max members

loading...

Hidden

loading...

With stub actions

loading...