zendesk-messaging-client
    Preparing search index...

    Type Alias ListConversationsData

    type ListConversationsData = {
        body?: never;
        path: { appId: string };
        query: {
            filter: { userExternalId?: string; userId?: string };
            page?: Page;
        };
        url: "/v2/apps/{appId}/conversations";
    }
    Index

    Properties

    body? path query url

    Properties

    Optionalbody

    body?: never
    path: { appId: string }

    Type declaration

    • appId: string

      Identifies the app.

    query: { filter: { userExternalId?: string; userId?: string }; page?: Page }

    Type declaration

    • filter: { userExternalId?: string; userId?: string }

      conversationListFilter Contains parameters for filtering the results.

      • OptionaluserExternalId?: string

        The external Id of the user. One of userId or userExternalId is required, but not both.

      • OptionaluserId?: string

        The user's id. One of userId or userExternalId is required, but not both.

    • Optionalpage?: Page

      Contains parameters for applying cursor pagination.

    url: "/v2/apps/{appId}/conversations"

    Settings

    Member Visibility

    On This Page

    Properties