updateUserPreferences

Deprecated

Example Query

mutation ExampleMutation($input: UserPreferences!) {
  updateUserPreferences(input: $input) {
    userId
    eidmId
    userName
    isOnSubscription
    onSubscription
    profileImages {
      userId
      isImagePresent
      hasProfileImage
      userThumbnails
      thumbnails
    }
    personalInfo {
      userName
      isOnSubscription
      primaryEmail
      language
      countryCode
      countryCodeAtCreation
      isOptIn
      optIn
      aboutMe
      dateOfBirth
    }
    preferences {
      isReceivingEmail
      receiveEmail
      isReceivingProductLearningContent
      receiveProductLearningContent
      isReceivingNewsTrendsOffers
      receiveNewsTrendsOffers
      isReceivingShareYourThoughts
      receiveShareYourThoughts
      isReceivingTrialLearningContent
      receiveTrialLearningContent
    }
    programGroups {
      link
      id
      name
      description
      defaultLocaleId
      locales
      programGroups
      programs
      customProperties
    }
    assignedFeatures {
      subscriberContextId
      features
    }
  }
}

Variables

{
  "input": {
    "id": "example",
    "emailId": "example",
    "preferences": {
      "language": "example",
      "isReceivingEmailInput": true,
      "receiveEmailInput": true,
      "isReceivingProductLearningContentInput": true,
      "receiveProductLearningContentInput": true,
      "isReceivingNewsTrendsOffersInput": true,
      "receiveNewsTrendsOffersInput": true,
      "isReceivingShareYourThoughtsInput": true,
      "receiveShareYourThoughtsInput": true,
      "isReceivingTrialLearningContentInput": true
    }
  }
}

Example response

{
  "data": {
    "updateUserPreferences": {
      "userId": "example",
      "eidmId": "example",
      "userName": "example",
      "isOnSubscription": true,
      "onSubscription": true,
      "profileImages": {
        "userId": "example",
        "isImagePresent": true,
        "hasProfileImage": true,
        "userThumbnails": {
          "sizeX20": null,
          "sizeX40": null,
          "sizeX50": null,
          "sizeX58": null,
          "sizeX80": null,
          "sizeX120": null,
          "sizeX160": null,
          "sizeX176": null,
          "sizeX240": null,
          "sizeX360": null
        },
        "thumbnails": {
          "sizeX20": null,
          "sizeX40": null,
          "sizeX50": null,
          "sizeX58": null,
          "sizeX80": null,
          "sizeX120": null,
          "sizeX160": null,
          "sizeX176": null,
          "sizeX240": null,
          "sizeX360": null
        }
      },
      "personalInfo": {
        "userName": "example",
        "isOnSubscription": true,
        "primaryEmail": "example",
        "language": "example",
        "countryCode": "example",
        "countryCodeAtCreation": "example",
        "isOptIn": true,
        "optIn": true,
        "aboutMe": "example",
        "dateOfBirth": "example"
      },
      "preferences": {
        "isReceivingEmail": true,
        "receiveEmail": true,
        "isReceivingProductLearningContent": true,
        "receiveProductLearningContent": true,
        "isReceivingNewsTrendsOffers": true,
        "receiveNewsTrendsOffers": true,
        "isReceivingShareYourThoughts": true,
        "receiveShareYourThoughts": true,
        "isReceivingTrialLearningContent": true,
        "receiveTrialLearningContent": true
      },
      "programGroups": {
        "link": 0,
        "id": "example",
        "name": "example",
        "description": "example",
        "defaultLocaleId": "example",
        "locales": [
          {
            "id": null,
            "displayTags": null
          }
        ],
        "programGroups": [
          null
        ],
        "programs": [
          {
            "link": null,
            "id": null,
            "name": null,
            "description": null,
            "defaultLocaleId": null,
            "locales": null,
            "customProperties": null,
            "programType": null,
            "displayOrder": null,
            "filters": null
          }
        ],
        "customProperties": [
          {
            "link": null,
            "key": null,
            "value": null
          }
        ]
      },
      "assignedFeatures": [
        {
          "subscriberContextId": "example",
          "features": [
            {
              "featureId": null,
              "lastUsageDate": null
            }
          ]
        }
      ]
    }
  }
}

Deprecated: Deprecated to comply with GraphQL API standard naming conventions. Use ‘updateUserPreferencesV2’ mutation instead.

Arguments

inputUserPreferencesRequired

Returns

an optional UserProfile

userIdStringOptional

The identifier for a user.

profileImagesProfileImagesOptional

The profile image links for the user.

personalInfoPersonalInfoOptional

Represents the personal info.

preferencesPreferencesOptional

Represents the user preferences.

identifiersUserIdentifiersOptional

Represents the identifiers for the user.

ancillaryProfileAncillaryProfileOptional

Represents the ancillary profile.

auProfileAUProfileOptional

Represents the AU profile.

productUsageV2ProductUsageV2Optional

Represents the product usage information V2.

userProfileMetadataUserProfileMetadataOptional

Represents the user profile metadata.

complianceInfoComplianceInfoOptional

Represents compliance information for the user.

inferredInfoInferredInfoOptional

Represent ML generated data

productPreferencesProductPreferencesOptional

Product-line-scoped preferences (notification settings) for the user. Provide productPreferencesFilter in the parent userProfile filter input.

additionalUserInfoSidecarProfileOptional

Represents additional user info stored for the user.

eidmIdStringOptionalDeprecated

Legacy identifier for the user.

Deprecated: Moved to UserIdentifiers field group.

userNameStringOptionalDeprecated

User name of the user.

Deprecated: Moved to PersonalInfo field group.

isOnSubscriptionBooleanOptionalDeprecated

The flag that indicates if the user has any subscription.

Deprecated: Moved to PersonalInfo field group.

onSubscriptionBooleanOptionalDeprecated

Deprecated: Deprecated to comply with GraphQL API standard naming conventions. Use ‘isOnSubscription’ field instead.

programGroupsProgramGroupsOptionalDeprecated

Represents the user’s program groups.

Deprecated: Use ‘userProfileMetadata’ query instead.

assignedFeatureslist of optional AssignedFeaturesOptionalDeprecated

Represents the product assignments for the user.

Deprecated: This feature is not available for consumption.

productUsageProductUsageOptionalDeprecated

Represents the product usage information.

Deprecated: Use productUsageV2 field instead. This V1 field will be removed in a future version.