zendesk-messaging-client
    Preparing search index...

    Type Alias ListClientsData

    type ListClientsData = {
        body?: never;
        path: { appId: string; userIdOrExternalId: string };
        query?: { page?: Page };
        url: "/v2/apps/{appId}/users/{userIdOrExternalId}/clients";
    }
    Index

    Properties

    Properties

    body?: never
    path: { appId: string; userIdOrExternalId: string }

    Type declaration

    • appId: string

      Identifies the app.

    • userIdOrExternalId: string

      The user's id or externalId.

    query?: { page?: Page }

    Type declaration

    • Optionalpage?: Page

      Contains parameters for applying cursor pagination.

    url: "/v2/apps/{appId}/users/{userIdOrExternalId}/clients"