1. Tasks
  2. Edit Contact List

Tasks

Edit Contact List

The Edit Contact List task edits the details of a contact list on the stub.

Basic usage

loading...

Parameters

list_name
required
string

This is name of the list that will be edited.


title
optional
string

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


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 edited contact list.