Contact programs: enrich, enroll, merge

Reference for Contact, one group of Contact programs.

Contact.enrich

Enrich fills a Contact’s missing fields from outside sources and marks each value with where it came from. Verb page.

Text

do: return await $.Contact.enrich(input)

Emits Contact.enriched.

Inputs

Input	Type	Required	Description
`contact`	Contact	required	The Contact to enrich.

Returns

Output	Type	Required	Description
`contact`	Contact	required	The enriched Contact.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	None.

Example

JSON

{
  "name": "do",
  "arguments": {
    "code": "return await $.Contact.enrich({ contact: 'contact_WsrosCQi6J' })"
  }
}

Contact.enroll

Enroll adds a Contact to a Sequence, which sends its steps until the Contact replies or exits. Verb page.

Text

do: return await $.Contact.enroll(input)

Emits Contact.enrolled.

Inputs

Input	Type	Required	Description
`contact`	Contact	required	The Contact to enroll.
`sequence`	Sequence	required	The Sequence to run.

Returns

Output	Type	Required	Description
`contact`	Contact	required	The enrolled Contact.
`enrollment`	Enrollment	required	The Enrollment that records this Contact’s run through the Sequence.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	None.
The record is not in a state that allows this Verb, so the call is refused.	`refused`	Read the record, run the Verb that moves it to an allowed state, then retry.	None.
A suppressed Contact or one with no consent for the Sequence’s purpose	`refused`	Clear what the check names, then call it again.	None.

Example

JSON

{
  "name": "do",
  "arguments": {
    "code": "return await $.Contact.enroll({ contact: 'contact_WsrosCQi6J', sequence: 'sequence_H7knHGrBdP' })"
  }
}

Contact.merge

Merge joins a duplicate Contact into another, keeping every link, Message and Event on the one that remains. Verb page.

Text

do: return await $.Contact.merge(input)

Emits Contact.merged.

Inputs

Input	Type	Required	Description
`contact`	Contact	required	The duplicate.
`into`	Contact	required	The Contact that remains.

Returns

Output	Type	Required	Description
`contact`	Contact	required	The remaining Contact.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	None.

Example

JSON

{
  "name": "do",
  "arguments": {
    "code": "return await $.Contact.merge({ contact: 'contact_WsrosCQi6J', into: 'contact_WsrosCQi6J' })"
  }
}

Contact.enrichCopy Anchor Link

Contact.enrollCopy Anchor Link

Contact.mergeCopy Anchor Link

Contact.enrich

Contact.enroll

Contact.merge