conversations.markAsDelivered()

This method allows you to mark a conversation as delivered when the conversation ID is provided.

Definition

client.conversations.markAsDelivered(
  conversationId: string|Object,
  options: ?Object
):Promise<Error>

Parameters

ParameterTypeDescription
conversationIdstring|ObjectA string containing a conversation Id or a Conversation object
options?ObjectOptions (described below)

Options

ParameterTypeDescription
lowestSortNumbernumberMessages with sort number less than or equal to this number should be marked as delivered

Returns

An error will be thrown if the conversation couldn't be marked as delivered.

Example

await client.conversations.markAsDelivered({
  conversationId: "some-conversation-id",
  options: { lowestSortNumber: "any-number" }
});