Update newsletter

put

https://www.pelcro.com/api/v1/sdk/newsletter/{email}

Update an existing newsletter subscription.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Overview

Update an existing newsletter subscription for the given email on the site. Public — no authentication required.

Example: Add the customer’s name and consent details to an existing newsletter entry.

Conditional Requirements

Condition	Required Fields
Always	`site_id`, `email`
The `email` must already be subscribed to this site	otherwise `400`

Path Params

string

required

The email address.

Query Params

site_id

int32

required

The unique identifier of the site associated with your account.

Body Params

source

string

length ≤ 32

Optional source for the newsletter subscription request (web, phone, mail, other), maximum 32 characters.

lists

string

length ≤ 65535

Optional comma separated lists.

first_name

string

length ≤ 255

Optional first name of the newsletter subscriber.

last_name

string

length ≤ 255

Optional last name of the newsletter subscriber.

consent_url

string

length ≤ 200

Optional URL from which the customer subscribed to the newsletter.

consent_text

string

length ≤ 100

Optional consent text which customer read before subscribing to the newsletter, maximum 100 characters.

consent_type

string

length ≤ 100

Optional consent type.

consent_ip

string

length ≤ 100

Optional IP address from which the consent was given.

postal_code

string

length ≤ 10

Optional postal code of the newsletter subscriber.

string

length ≤ 100

The email address associated with the newsletter subscription.

Responses

Language

Credentials

Query

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Overview

Conditional Requirements

200Success.

400Invalid request.