Class: Tags

Tags

Tags - Used for communication with intercomClient's tags objects

Constructor

new Tags()

Source:

Methods

create(tag) → {Promise}

Create or update a tag on a company/user object, passes data through to intercom
Parameters:
Name Type Description
tag Object
Properties
Name Type Description
id String Tag unique identifier
name String Tag name
Source:
See:
Returns:
- Returns success if intercom is disabled, otherwise returns results of create command in intercom
Type
Promise

delete(tag) → {Promise}

Delete a tag
Parameters:
Name Type Description
tag Object
Properties
Name Type Description
id String Array of companies to untag (can use id, company_id)
Source:
Returns:
- Returns success if intercom is disabled, otherwise returns results of delete command in intercom
Type
Promise

tag(tag) → {Promise}

Create or update a tag on a company/user object, passes data through to intercom
Parameters:
Name Type Description
tag Object
Properties
Name Type Description
companies Array Array of companies to tag (can use id, company_id)
users Array Array of users to tag (can use id, user_id)
name String Tag name [Required]
Source:
Returns:
- Returns success if intercom is disabled, otherwise returns results of tag command in intercom
Type
Promise

untag(tag) → {Promise}

Remove a tag from a company/user object, passes data through to intercom
Parameters:
Name Type Description
tag Object
Properties
Name Type Description
companies Array Array of companies to untag (can use id, company_id)
users Array Array of users to untag (can use id, user_id)
name String Tag name [required]
Source:
Returns:
- Returns success if intercom is disabled, otherwise returns results of untag command in intercom
Type
Promise