1. Tasks
  2. Add Contact

Tasks

Add Contact

The Add Contact task adds a contact to a stub's pre-existing contact list.
The contact can be added to the list using the contactuuid of the contact in the Org's contacts directory.

Basic usage

Add a contact to the Field Technicians contact list.

loading...

Parameters

list_name
required
string

The name of the list to add the contact to.


contactuuid
optional
string

The contactuuid of the contact to which to add to the list.


type
optional
string

The type of contactpoint associated with the contactuuid to be added to the list.

Options: email stubberhandle mobile
Refer to the Contacts documentation for more information on the type of contactpoints.

required
if contactuuid is not provided.
contactpoint
optional
string

The contact's contactpoint to be added to the list. If the contactuuid associated with the contactpoint is not already in the list, it will be added.

required
if contactuuid is not provided.

Result

loading...

Properties

list_name
string

The name of the list the contact was added to.

contactuuid
string

The contact's unique identifier which was added to the contact list.

contact
object

The contact that was retrieved.

Show child attributes
avatar
object

The contact's avatar.

Show child attributes

The link to the contact's avatar.

type
string

The type of avatar.

basic
object
Show child attributes
descname
string

A descriptive name for the contact. This is the combination of the contact's first name, middle names, and last name.

firstname
string

The contact's first name.

middlenames
string

The contact's middle names.

lastname
string

The contact's last name.

contactpoints
array of objects
Show child attributes
contact
string

The contact "value" of the contactpoint. This could be an email address, mobile number, or a handle.

type
string

The type of contactpoint. This could be:

  • email
  • stubberhandle
  • mobile
  • slack

etc.

uuid
string

The unique identifier of the contactpoint.

contactuuid
string

The contact's unique identifier.

orguuid
string

The unique identifier of the Org the contact belongs to.

type
string

The type of contact. This could be individual or group.

createdAt
string

The date and time the contact was created.

updatedAt
string

The date and time the contact was last updated.

Examples

These are some more complex examples

Add Contact using email contact point

loading...

Result

loading...