Shopware icon

Shopware

Shopware

Actions778

Newsletter Recipient → Create Newsletter Recipient

AI-generated

Overview

This node operation creates a new newsletter recipient in the Shopware system. It is useful for scenarios where you want to add subscribers to a newsletter list programmatically, such as during user registration or marketing campaigns. For example, you can automate adding new customers to your newsletter list with their contact and address details.

Use Case Examples

  1. Adding a new subscriber with email, name, and address to the newsletter list.
  2. Automating newsletter recipient creation after a purchase or signup.

Properties

Name Meaning
Response Data format for the response, either basic or detailed.
Id Unique identifier for the newsletter recipient.
Email Email address of the newsletter recipient.
Title Title of the newsletter recipient (e.g., Mr., Ms.).
First Name First name of the newsletter recipient.
Last Name Last name of the newsletter recipient.
Zip Code Zip code of the newsletter recipient's address.
City City of the newsletter recipient's address.
Street Street address of the newsletter recipient.
Status Status of the newsletter recipient (required).
Hash Hash value for the newsletter recipient (required).
Custom Fields Custom fields in JSON format for additional data.
Confirmed At Timestamp when the recipient confirmed subscription.
Salutation Id Identifier for the salutation.
Language Id Identifier for the language (required).
Sales Channel Id Identifier for the sales channel (required).
Created At Timestamp when the recipient was created.
Updated At Timestamp when the recipient was last updated.
Tags Tags associated with the newsletter recipient in JSON format.
Salutation Salutation details in JSON format.
Language Language details in JSON format.
Sales Channel Sales channel details in JSON format.
Request Options Node settings for request options such as batching, SSL issues, proxy, and timeout.

Output

JSON

  • id - Unique identifier of the created newsletter recipient.
  • email - Email address of the created newsletter recipient.
  • status - Status of the created newsletter recipient.
  • firstName - First name of the created newsletter recipient.
  • lastName - Last name of the created newsletter recipient.
  • createdAt - Creation timestamp of the newsletter recipient.
  • updatedAt - Last update timestamp of the newsletter recipient.
  • customFields - Custom fields associated with the newsletter recipient.
  • tags - Tags associated with the newsletter recipient.
  • languageId - Language identifier associated with the newsletter recipient.
  • salesChannelId - Sales channel identifier associated with the newsletter recipient.

Dependencies

  • An API key credential for Shopware Admin API

Troubleshooting

  • Ensure all required fields (Id, Email, Status, Hash, Language Id, Sales Channel Id) are provided to avoid validation errors.
  • Check API credentials and base URL configuration if authentication fails.
  • If the response format is not as expected, verify the '_response' property setting (basic or detail).
  • For network issues, verify proxy and timeout settings in Request Options.

Discussion