Namespace

Journal

CustomersService#Journal

Methods

# static create(humanIds, entry) → {Promise.<ServiceResponse>}

Creates journal entries on one or more entities.

Parameters:
Name Type Attributes Description
humanIds Array.<string>

One or more entity human-readable identifiers.

entry Object

The journal entry data.

channel string

One of NOTE, PHONE, MOBILE, FAX, EMAIL, CONVERSATION, CALENDAR_EVENT, FILE, JIRA, MAIL

direction string <optional>

One of UNKNOWN, INCOMING, OUTGOING. Only valid for PHONE, MOBILE, FAX, EMAIL, MAIL.

text string

Entry text (required).

View Source services/CustomersService.class.js, line 444

Array of created journal docs.

Promise.<ServiceResponse>
Example
await customers.Journal.create(['person-abc123'], { channel: 'NOTE', text: 'Spoke to client.' })
await customers.Journal.create(['person-abc123', 'ou-xyz'], { channel: 'PHONE', direction: 'INCOMING', text: 'Called in.' })