Typescript SDK Type Docs
    Preparing search index...

    Interface ModifiedBy

    Information about the user or API Client who performed the change. This is a variant of LastModifiedBy.

    interface ModifiedBy {
        anonymousId?: string;
        associate?: Reference;
        clientId?: string;
        customer?: Reference;
        id?: string;
        isPlatformClient: boolean;
        type: string;
    }
    Index

    Properties

    anonymousId? associate? clientId? customer? id? isPlatformClient type

    Properties

    anonymousId?: string

    Present only if the change was made using a token from an anonymous session.

    associate?: Reference

    The Associate who made the change in the context of a Business Unit. Only available for B2B-enabled Projects when an Associate acts on behalf of a company using the associate endpoints.

    clientId?: string

    ID of the API Client that made the change.

    Present only if the change was made using an API Client.
    customer?: Reference

    The Customer who made the change.

    Present only if the change was made using a token from the [password flow](/authorization#password-flow).
    id?: string

    ID of the Merchant Center user who made the change.

    Present only if `isPlatformClient` is `true`.
    isPlatformClient: boolean

    true if the change was made using the Merchant Center.

    type: string

    Indicates who performed the change.

    - If the change was made by a user, the value is `"user"`.
- If the change was made by an API Client with or without an [external user ID](/general-concepts#external-user-ids), the value is `"external-user"`.
- If the change was made by an [Associate](ctp:api:type:Associate), the value is `"associate"`.

    Settings

    Member Visibility

    On This Page

    Properties