Function edit

  • edit(
        newsletterId: string,
        opts: { description?: string; name?: string; picture?: string },
    ): Promise<ResultCreateNewsletter>

  • Edit the newsletter data

    Parameters

    • newsletterId: string
    • opts: { description?: string; name?: string; picture?: string }

    Returns Promise<ResultCreateNewsletter>

    Example

    // To edit name
    const code = WPP.newsletter.edit('[newsletter-id]@newsletter', {
    name: 'New Name'
    });

    // To edit description
    const code = WPP.newsletter.edit('[newsletter-id]@newsletter', {
    description: 'New description'
    });

    // To change picture
    const code = WPP.newsletter.edit('[newsletter-id]@newsletter', {
    picture: '<base64_image>'
    });

    // To remove picture
    const code = WPP.newsletter.edit('[newsletter-id]@newsletter', {
    picture: null
    });

Settings

Member Visibility