Shopware icon

Shopware

Shopware

Actions778

Newsletter Recipient → Update Newsletter Recipient

AI-generated

Overview

This node operation updates an existing newsletter recipient's information in the Shopware system. It is useful for scenarios where you need to modify recipient details such as email, name, address, status, language, sales channel, and custom fields. For example, you can update a recipient's email address, change their subscription status, or add custom tags.

Use Case Examples

  1. Updating a newsletter recipient's email and status after they change their subscription preferences.
  2. Modifying the recipient's address details and language settings for targeted marketing campaigns.

Properties

Name Meaning
Id Identifier for the newsletter_recipient, used to specify which recipient to update.
_response Data format for the response, used to specify the desired response format from the API.
email The email address of the newsletter recipient to update.
title The title of the newsletter recipient (e.g., Mr., Mrs.).
firstName The first name of the newsletter recipient.
lastName The last name of the newsletter recipient.
zipCode The zip code of the newsletter recipient's address.
city The city of the newsletter recipient's address.
street The street address of the newsletter recipient.
status The subscription status of the newsletter recipient.
hash A hash value associated with the newsletter recipient, likely for verification or security.
customFields Custom fields in JSON format for additional recipient data.
confirmedAt Timestamp when the recipient confirmed their subscription.
salutationId Identifier for the salutation of the recipient.
languageId Identifier for the language preference of the recipient.
salesChannelId Identifier for the sales channel associated with the recipient.
createdAt Timestamp when the recipient record was created.
updatedAt Timestamp when the recipient record was last updated.
tags Tags associated with the newsletter recipient, provided in JSON format.
salutation Salutation details in JSON format, added since version 6.0.0.0.
language Language details in JSON format, added since version 6.0.0.0.
salesChannel Sales channel details in JSON format, added since version 6.0.0.0.

Output

JSON

  • id - The unique identifier of the updated newsletter recipient.
  • email - The updated email address of the newsletter recipient.
  • status - The updated subscription status of the newsletter recipient.
  • firstName - The updated first name of the newsletter recipient.
  • lastName - The updated last name of the newsletter recipient.
  • customFields - Any updated custom fields associated with the recipient.
  • tags - Updated tags associated with the newsletter recipient.

Dependencies

  • An API key credential for Shopware Admin API authentication.

Troubleshooting

  • Ensure the 'Id' property is correctly set to identify the recipient to update; missing or incorrect Id will cause update failure.
  • Verify that required fields such as 'email', 'status', 'hash', 'languageId', and 'salesChannelId' are provided to avoid validation errors.
  • Check the format of JSON fields like 'customFields', 'tags', 'salutation', 'language', and 'salesChannel' to ensure they are valid JSON strings.
  • If the API returns SSL certificate errors, consider enabling the 'Ignore SSL Issues' option if appropriate for your environment.
  • Timeouts can occur if the server is slow; adjust the 'Timeout' setting in request options accordingly.

Discussion