api.md

Shared

Types:

• Condition
• PageInfo

Recipients

Types:

• Recipient
• RecipientReference
• RecipientRequest

Subscriptions

Types:

• Subscription

Preferences

Types:

• InlinePreferenceSetRequest
• PreferenceSet
• PreferenceSetChannelSetting
• PreferenceSetChannelTypeSetting
• PreferenceSetChannelTypes
• PreferenceSetRequest

ChannelData

Types:

• AwsSnsPushChannelDataDevicesOnly
• AwsSnsPushChannelDataTargetArnsOnly
• ChannelData
• ChannelDataRequest
• DiscordChannelData
• InlineChannelDataRequest
• MsTeamsChannelData
• OneSignalChannelDataPlayerIDsOnly
• PushChannelDataDevicesOnly
• PushChannelDataTokensOnly
• SlackChannelData

Users

Types:

• IdentifyUserRequest
• InlineIdentifyUserRequest
• User
• UserListPreferencesResponse

Methods:

• client.users.update(userID, { ...params }) -> User
• client.users.list({ ...params }) -> UsersEntriesCursor
• client.users.delete(userID) -> void
• client.users.get(userID) -> User
• client.users.getChannelData(userID, channelID) -> ChannelData
• client.users.getPreferences(userID, id, { ...params }) -> PreferenceSet
• client.users.listMessages(userID, { ...params }) -> MessagesItemsCursor
• client.users.listPreferences(userID) -> UserListPreferencesResponse
• client.users.listSchedules(userID, { ...params }) -> SchedulesEntriesCursor
• client.users.listSubscriptions(userID, { ...params }) -> SubscriptionsEntriesCursor
• client.users.merge(userID, { ...params }) -> User
• client.users.setChannelData(userID, channelID, { ...params }) -> ChannelData
• client.users.setPreferences(userID, id, { ...params }) -> PreferenceSet
• client.users.unsetChannelData(userID, channelID) -> void
• client.users.unsetPreferences(userID, id) -> void

Feeds

Types:

• FeedGetSettingsResponse
• FeedListItemsResponse

Methods:

• client.users.feeds.getSettings(userID, id) -> FeedGetSettingsResponse
• client.users.feeds.listItems(userID, id, { ...params }) -> FeedListItemsResponsesEntriesCursor

Guides

Types:

• GuideGetChannelResponse
• GuideMarkMessageAsArchivedResponse
• GuideMarkMessageAsInteractedResponse
• GuideMarkMessageAsSeenResponse

Methods:

• client.users.guides.getChannel(userID, channelID, { ...params }) -> GuideGetChannelResponse
• client.users.guides.markMessageAsArchived(userID, messageID, { ...params }) -> GuideMarkMessageAsArchivedResponse
• client.users.guides.markMessageAsInteracted(userID, messageID, { ...params }) -> GuideMarkMessageAsInteractedResponse
• client.users.guides.markMessageAsSeen(userID, messageID, { ...params }) -> GuideMarkMessageAsSeenResponse

Bulk

Methods:

• client.users.bulk.delete({ ...params }) -> BulkOperation
• client.users.bulk.identify({ ...params }) -> BulkOperation
• client.users.bulk.setPreferences({ ...params }) -> BulkOperation

Objects

Types:

• InlineObjectRequest
• Object
• ObjectAddSubscriptionsResponse
• ObjectDeleteSubscriptionsResponse
• ObjectListPreferencesResponse

Methods:

• client.objects.list(collection, { ...params }) -> ObjectsEntriesCursor
• client.objects.delete(collection, id) -> void
• client.objects.addSubscriptions(collection, objectID, { ...params }) -> ObjectAddSubscriptionsResponse
• client.objects.deleteSubscriptions(collection, objectID, { ...params }) -> ObjectDeleteSubscriptionsResponse
• client.objects.get(collection, id) -> Object
• client.objects.getChannelData(collection, objectID, channelID) -> ChannelData
• client.objects.getPreferences(collection, objectID, id) -> PreferenceSet
• client.objects.listMessages(collection, id, { ...params }) -> MessagesItemsCursor
• client.objects.listPreferences(collection, objectID) -> ObjectListPreferencesResponse
• client.objects.listSchedules(collection, id, { ...params }) -> SchedulesEntriesCursor
• client.objects.listSubscriptions(collection, objectID, { ...params }) -> SubscriptionsEntriesCursor
• client.objects.set(collection, id, { ...params }) -> Object
• client.objects.setChannelData(collection, objectID, channelID, { ...params }) -> ChannelData
• client.objects.setPreferences(collection, objectID, id, { ...params }) -> PreferenceSet
• client.objects.unsetChannelData(collection, objectID, channelID) -> void
• client.objects.unsetPreferences(collection, objectID, id) -> void

Bulk

Methods:

• client.objects.bulk.delete(collection, { ...params }) -> BulkOperation
• client.objects.bulk.addSubscriptions(collection, { ...params }) -> BulkOperation
• client.objects.bulk.deleteSubscriptions(collection, { ...params }) -> BulkOperation
• client.objects.bulk.set(collection, { ...params }) -> BulkOperation

Tenants

Types:

• InlineTenantRequest
• Tenant
• TenantRequest

Methods:

• client.tenants.list({ ...params }) -> TenantsEntriesCursor
• client.tenants.delete(id) -> void
• client.tenants.get(id, { ...params }) -> Tenant
• client.tenants.set(id, { ...params }) -> Tenant

Bulk

Methods:

• client.tenants.bulk.delete({ ...params }) -> BulkOperation
• client.tenants.bulk.set({ ...params }) -> BulkOperation

BulkOperations

Types:

• BulkOperation

Methods:

• client.bulkOperations.get(id) -> BulkOperation

Messages

Types:

• Activity
• Message
• MessageDeliveryLog
• MessageEvent
• MessageGetContentResponse

Methods:

• client.messages.list({ ...params }) -> MessagesItemsCursor
• client.messages.archive(messageID) -> Message
• client.messages.get(messageID) -> Message
• client.messages.getContent(messageID) -> MessageGetContentResponse
• client.messages.listActivities(messageID, { ...params }) -> ActivitiesItemsCursor
• client.messages.listDeliveryLogs(messageID, { ...params }) -> MessageDeliveryLogsItemsCursor
• client.messages.listEvents(messageID, { ...params }) -> MessageEventsItemsCursor
• client.messages.markAsInteracted(messageID, { ...params }) -> Message
• client.messages.markAsRead(messageID) -> Message
• client.messages.markAsSeen(messageID) -> Message
• client.messages.markAsUnread(messageID) -> Message
• client.messages.markAsUnseen(messageID) -> Message
• client.messages.unarchive(messageID) -> Message

Batch

Types:

• BatchArchiveResponse
• BatchGetContentResponse
• BatchMarkAsInteractedResponse
• BatchMarkAsReadResponse
• BatchMarkAsSeenResponse
• BatchMarkAsUnreadResponse
• BatchMarkAsUnseenResponse
• BatchUnarchiveResponse

Methods:

• client.messages.batch.archive({ ...params }) -> BatchArchiveResponse
• client.messages.batch.getContent({ ...params }) -> BatchGetContentResponse
• client.messages.batch.markAsInteracted({ ...params }) -> BatchMarkAsInteractedResponse
• client.messages.batch.markAsRead({ ...params }) -> BatchMarkAsReadResponse
• client.messages.batch.markAsSeen({ ...params }) -> BatchMarkAsSeenResponse
• client.messages.batch.markAsUnread({ ...params }) -> BatchMarkAsUnreadResponse
• client.messages.batch.markAsUnseen({ ...params }) -> BatchMarkAsUnseenResponse
• client.messages.batch.unarchive({ ...params }) -> BatchUnarchiveResponse

Providers

Slack

Types:

• SlackCheckAuthResponse
• SlackListChannelsResponse
• SlackRevokeAccessResponse

Methods:

• client.providers.slack.checkAuth(channelID, { ...params }) -> SlackCheckAuthResponse
• client.providers.slack.listChannels(channelID, { ...params }) -> SlackListChannelsResponsesSlackChannelsCursor
• client.providers.slack.revokeAccess(channelID, { ...params }) -> SlackRevokeAccessResponse

MsTeams

Types:

• MsTeamCheckAuthResponse
• MsTeamListChannelsResponse
• MsTeamListTeamsResponse
• MsTeamRevokeAccessResponse

Methods:

• client.providers.msTeams.checkAuth(channelID, { ...params }) -> MsTeamCheckAuthResponse
• client.providers.msTeams.listChannels(channelID, { ...params }) -> MsTeamListChannelsResponse
• client.providers.msTeams.listTeams(channelID, { ...params }) -> MsTeamListTeamsResponsesMsTeamsPagination
• client.providers.msTeams.revokeAccess(channelID, { ...params }) -> MsTeamRevokeAccessResponse

Integrations

Census

Types:

• CensusCustomDestinationResponse

Methods:

• client.integrations.census.customDestination({ ...params }) -> CensusCustomDestinationResponse

Hightouch

Types:

• HightouchEmbeddedDestinationResponse

Methods:

• client.integrations.hightouch.embeddedDestination({ ...params }) -> HightouchEmbeddedDestinationResponse

Workflows

Types:

• WorkflowTriggerResponse

Methods:

• client.workflows.cancel(key, { ...params }) -> void
• client.workflows.trigger(key, { ...params }) -> WorkflowTriggerResponse

WorkflowRecipientRuns

Types:

• WorkflowRecipientRun
• WorkflowRecipientRunDetail
• WorkflowRecipientRunEvent

Methods:

• client.workflowRecipientRuns.list({ ...params }) -> WorkflowRecipientRunsItemsCursor
• client.workflowRecipientRuns.get(id) -> WorkflowRecipientRunDetail

Schedules

Types:

• Schedule
• ScheduleRepeatRule
• ScheduleCreateResponse
• ScheduleUpdateResponse
• ScheduleDeleteResponse

Methods:

• client.schedules.create({ ...params }) -> ScheduleCreateResponse
• client.schedules.update({ ...params }) -> ScheduleUpdateResponse
• client.schedules.list({ ...params }) -> SchedulesEntriesCursor
• client.schedules.delete({ ...params }) -> ScheduleDeleteResponse

Bulk

Methods:

• client.schedules.bulk.create({ ...params }) -> BulkOperation

Channels

Bulk

Methods:

• client.channels.bulk.updateMessageStatus(channelID, action, { ...params }) -> BulkOperation

Audiences

Types:

• AudienceMember
• AudienceListMembersResponse

Methods:

• client.audiences.addMembers(key, { ...params }) -> void
• client.audiences.listMembers(key) -> AudienceListMembersResponse
• client.audiences.removeMembers(key, { ...params }) -> void