kustomer-client
    Preparing search index...

    Type Alias CreateUnmaskingWindowByCustomerData

    type CreateUnmaskingWindowByCustomerData = {
        body?: unknown;
        path: { id: string };
        query?: never;
        url: "/customers/{id}/unmasking-windows";
    }
    Index

    Properties

    body? path query? url

    Properties

    Optionalbody

    body?: unknown

    Creates a new or replaces an existing unmasking window for a customer.

    Any one of the following roles is required for this endpoint:

    Legacy Role Equivalent Permission Set Role
    org.user.customer.write org.permission.unmasking_window.create

    If an unmasking window is created for a customer, any sensitive attributes for the customer and for the customer's conversations, messages, and custom objects will be returned unmasked during the unmasking window period.

    path: { id: string }

    Type declaration

    • id: string

      Unique ID of the customer.

    query?: never
    url: "/customers/{id}/unmasking-windows"

    Settings

    Member Visibility

    On This Page

    Properties