intercom-client/api/resources/conversations/client/requests/UpdateConversationRequest.d.ts

Official Node bindings to the Intercom API

/**
 * This file was auto-generated by Fern from our API Definition.
 */
import * as Intercom from "../../../../index";
/**
 * @example
 *     {
 *         conversation_id: "123",
 *         display_as: "plaintext",
 *         read: true,
 *         custom_attributes: {
 *             "issue_type": "Billing",
 *             "priority": "High"
 *         }
 *     }
 *
 * @example
 *     {
 *         conversation_id: "123",
 *         display_as: "plaintext",
 *         read: true,
 *         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;
    custom_attributes?: Intercom.CustomAttributes;
}