Create newsletter

post

https://www.pelcro.com/api/v1/core/newsletters

Create a new newsletter subscriber.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Overview

Create a new newsletter subscriber. The email must be unique per site.

Example: A visitor subscribes via your website footer form. Create a record with their email, source web, and the consent URL.

Default Values

When omitted, consent_url, consent_ip, consent_text, and consent_type are stored as empty strings ("") not null.

Query Params

site_id

int32

required

≥ 1

The unique identifier of the site associated with your account.

Body Params

string

required

Subscriber email. Must be unique per site. Validated with RFC filter.

source

string

enum

required

Signup source. Input is lowercased automatically.

Allowed:

first_name

string

length ≤ 255

Subscriber first name.

last_name

string

length ≤ 255

Subscriber last name.

postal_code

string

length ≤ 10

Subscriber postal/zip code.

lists

string

Free-text string for list assignments (no format enforced).

consent_url

string

length ≤ 200

URL where consent was given. Defaults to empty string if omitted.

consent_ip

string

IP where consent was given. Must be valid IPv4 or IPv6. Defaults to empty string if omitted.

consent_text

string

length ≤ 100

Consent text shown to subscriber. Defaults to empty string if omitted.

consent_type

string

length ≤ 100

Type of consent (e.g. explicit, implied). Defaults to empty string if omitted.

Headers

Authorization

string

required

Defaults to Bearer eyJ***

Responses

Language

Credentials

Loading…

Response

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

application/json

Overview

Default Values

201Created.

400Invalid request.

401Unauthenticated.