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;
}

Properties

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

Properties

Optional ReadonlyanonymousId

anonymousId?: string

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

Optional Readonlyassociate

associate?: Reference

The Associate who made the change in the context of a Business Unit. Present only if the Associate acts on behalf of a company using the associate endpoints.

Optional ReadonlyclientId

clientId?: string

ID of the API Client that made the change.

Present only if the change was made using an API Client.

Optional Readonlycustomer

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).

Optional Readonlyid

id?: string

ID of the Merchant Center user who made the change.

Present only if `isPlatformClient` is `true`.

ReadonlyisPlatformClient

isPlatformClient: boolean

true if the change was made using the Merchant Center.

Readonlytype

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