zendesk-messaging-client
    Preparing search index...

    Type Alias ConversationCreateBody

    ConversationCreateBody

    type ConversationCreateBody = {
        description?: Description;
        displayName?: DisplayName;
        iconUrl?: Icon;
        metadata?: Metadata;
        participants?: ParticipantSubSchema[];
        type: ConversationType;
    }
    Index

    Properties

    description? displayName? iconUrl? metadata? participants? type

    Properties

    description?: Description
    displayName?: DisplayName

    A friendly name for the conversation, may be displayed to the business or the user.

    iconUrl?: Icon
    metadata?: Metadata
    participants?: ParticipantSubSchema[]

    The users participating in the conversation. For personal conversations, this field is required with a length of exactly 1. For sdkGroup conversations, must have a length less than or equal to 10. Can be omitted to have a conversation with no participants if the type is sdkGroup.

    type: ConversationType

    Settings

    Member Visibility

    On This Page

    Properties