zendesk-messaging-client
    Preparing search index...

    Type Alias UserMergeEventWritable

    UserMergeEventWritable: EventSubSchema & {
        payload?: {
            discardedMetadata?: Metadata | null;
            mergedClients?:
                | { discarded?: Types.Client; surviving?: Types.Client }
                | null;
            mergedConversations?:
                | {
                    discarded?: ConversationTruncated;
                    surviving?: ConversationTruncated;
                }
                | null;
            mergedUsers?: { discarded?: UserWritable; surviving?: UserWritable };
            reason?: "api" | "channelLinking" | "sdkLogin";
        };
    }

    user:merge

    Type declaration

    • Optionalpayload?: {
          discardedMetadata?: Metadata | null;
          mergedClients?:
              | { discarded?: Types.Client; surviving?: Types.Client }
              | null;
          mergedConversations?:
              | {
                  discarded?: ConversationTruncated;
                  surviving?: ConversationTruncated;
              }
              | null;
          mergedUsers?: { discarded?: UserWritable; surviving?: UserWritable };
          reason?: "api" | "channelLinking" | "sdkLogin";
      }

      The payload of the event. The contents of this object depend on the type of event.

      • OptionaldiscardedMetadata?: Metadata | null

        A flat object with the set of metadata properties that were discarded when merging the two users. This should contain values only if the combined metadata fields exceed the 4KB limit.

      • OptionalmergedClients?: { discarded?: Types.Client; surviving?: Types.Client } | null

        Contains information about the clients that were merged together as a result of the operation, if applicable. If no clients were merged, this property is omitted.

      • OptionalmergedConversations?: { discarded?: ConversationTruncated; surviving?: ConversationTruncated } | null

        Contains information about the conversations that were merged together as a result of the operation, if applicable. If no conversations were merged, this property is omitted.

      • OptionalmergedUsers?: { discarded?: UserWritable; surviving?: UserWritable }

        Contains information about the users that were merged together.

        • Optionaldiscarded?: UserWritable

          The user that was unified into the surviving user object.

        • Optionalsurviving?: UserWritable

          The user that now represents the merged user object.

      • Optionalreason?: "api" | "channelLinking" | "sdkLogin"

        The reason for which the users merged.

        • api - The users were merged using the API.
        • channelLinking - The users were merged as a result of initiating a channel link.
        • sdkLogin - The users were merged as a result of logging into an SDK device.

    Settings

    Member Visibility