intercom-client
Version:
Official Node bindings to the Intercom API
49 lines (48 loc) • 1.47 kB
text/typescript
import type * as Intercom from "../../../../index.mjs";
/**
* @example
* {
* conversation_id: "conversation_id",
* display_as: "plaintext",
* read: true,
* title: "new conversation title",
* custom_attributes: {
* "issue_type": "Billing",
* "priority": "High"
* }
* }
*
* @example
* {
* conversation_id: "conversation_id",
* display_as: "plaintext",
* custom_attributes: {
* "order": {}
* }
* }
*
* @example
* {
* conversation_id: "conversation_id",
* display_as: "plaintext",
* read: true,
* title: "new conversation title",
* custom_attributes: {
* "issue_type": "Billing",
* "priority": "High"
* }
* }
*/
export interface UpdateConversationRequest {
/** The id of the conversation to target */
conversation_id: string;
/** Set to plaintext to retrieve conversation messages in plain text. */
display_as?: string;
/** Mark a conversation as read within Intercom. */
read?: boolean;
/** The title given to the conversation */
title?: string;
custom_attributes?: Intercom.CustomAttributes;
/** The ID of the company that the conversation is associated with. The unique identifier for the company which is given by Intercom. Set to nil to remove company. */
company_id?: string;
}