Campaigns
create
campaigns.create
Create a regular email campaign
Risk: write
from full type
from full type
stats full type
stats full type
campaign full type
campaign full type
delete
campaigns.delete
Delete an unsent or previously sent campaign
Risk: destructive
campaign full type
campaign full type
get
campaigns.get
Retrieve a specific campaign by ID
Risk: read
campaign full type
campaign full type
get_content
campaigns.get_content
Retrieve the HTML and plaintext campaign content
Risk: read
campaign full type
campaign full type
history
campaigns.history
Retrieve paginated events for a campaign
Risk: read
pagination full type
pagination full type
order full type
order full type
data full type
data full type
list
campaigns.list
Retrieve all email campaigns
Risk: read
limit (1–1000) and cursor to page through campaigns. status may be draft or sent.
Output
data full type
data full type
pagination full type
pagination full type
schedule
campaigns.schedule
Schedule campaign delivery to its configured recipients
Risk: destructive
campaign full type
campaign full type
send
campaigns.send
Send a campaign to its configured recipients
Risk: destructive
campaign full type
campaign full type
send_test
campaigns.send_test
Send a campaign test email to the specified address
Risk: destructive
campaign full type
campaign full type
update
campaigns.update
Update campaign metadata and recipients
Risk: write
from full type
from full type
stats full type
stats full type
campaign full type
campaign full type
update_content
campaigns.update_content
Set campaign content from HTML or an import URL
Risk: write
html or import_url. Laposta imports HTML from the URL when selected; if both are provided, the html value takes precedence. Only exported campaigns support content retrieval.
Output
campaign full type
campaign full type
Fields
create
fields.create
Create a new custom field for a mailing list
Risk: write
required, in_form, and in_list booleans are mandatory. Select fields need at least one option.
Output
field full type
field full type
delete
fields.delete
Delete a custom field from a mailing list
Risk: destructive
field full type
field full type
get
fields.get
Retrieve a specific custom field by ID
Risk: read
field full type
field full type
list
fields.list
Retrieve custom fields for a mailing list
Risk: read
data full type
data full type
update
fields.update
Update a custom field; changing its datatype removes stored values
Risk: destructive
options_full to be sent as JSON and treats it as a complete replacement: include every option to keep, omitted IDs are deleted, and non-numeric keys such as new-0 add options. Existing option IDs are numeric in field responses; array updates accept numeric IDs and temporary string IDs. Changing a field datatype removes its stored values.
options_full full type
options_full full type
field full type
field full type
Lists
create
lists.create
Create a new mailing list
Risk: write
list full type
list full type
delete
lists.delete
Delete a mailing list
Risk: destructive
list full type
list full type
get
lists.get
Retrieve a specific mailing list by ID
Risk: read
list full type
list full type
list
lists.list
Retrieve all mailing lists
Risk: read
data full type
data full type
purge_members
lists.purge_members
Permanently remove every active member from a mailing list
Risk: destructive
list full type
list full type
sync_members
lists.sync_members
Add, update, or bulk-unsubscribe members in a mailing list
Risk: destructive
unsubscribe_excluded action unsubscribes every current member omitted from the submitted list; double-check the complete member set before using it.
members full type
members full type
report full type
report full type
errors full type
errors full type
skipped full type
skipped full type
edited full type
edited full type
added full type
added full type
update
lists.update
Update an existing mailing list
Risk: write
list full type
list full type
Members
create
members.create
Subscribe a member, which may send a confirmation email
Risk: destructive
ip is mandatory. On a double-opt-in list Laposta can send a confirmation email; options.ignore_doubleoptin disables that confirmation behavior.
options full type
options full type
member full type
member full type
delete
members.delete
Unsubscribe or delete a member from a list
Risk: destructive
member full type
member full type
get
members.get
Retrieve a specific subscriber by ID
Risk: read
member full type
member full type
history
members.history
Retrieve a member event history with cursor pagination
Risk: read
pagination full type
pagination full type
order full type
order full type
data full type
data full type
list
members.list
Retrieve subscribers for a mailing list
Risk: read
limit (1–1000) and cursor to page. Pass pagination.next_cursor unchanged and retain the other filters. A plus sign in an email used as member_id is encoded as %252B in the path.
Output
data full type
data full type
pagination full type
pagination full type
update
members.update
Update an existing subscriber
Risk: write
member full type
member full type
Reports
get
reports.get
Retrieve analytics and delivery report for a campaign
Risk: read
report full type
report full type
list
reports.list
Retrieve paginated delivery reports for campaigns
Risk: read
limit (1–1000) and cursor to page through campaign reports.
Output
data full type
data full type
pagination full type
pagination full type
Segments
create
segments.create
Create a segment for a mailing list
Risk: write
{"blocks":[{"rules":[{"input":{"subject":"domain","comparator":"equal","multi":"","text":"example.com"},"type":"members"}]}]}. Laposta rejects anything else with “definition is no valid JSON”. The easiest way to get one is to build the segment in Laposta and read it with segments.get.
Output
segment full type
segment full type
delete
segments.delete
Permanently delete a mailing-list segment
Risk: destructive
segment full type
segment full type
get
segments.get
Retrieve one mailing-list segment and its definition
Risk: read
segment full type
segment full type
list
segments.list
Retrieve all segments belonging to a mailing list
Risk: read
data full type
data full type
update
segments.update
Change a segment name or definition
Risk: write
segment full type
segment full type
Webhooks
create
webhooks.create
Create a webhook subscription for a mailing list
Risk: write
webhook full type
webhook full type
delete
webhooks.delete
Permanently delete a webhook subscription
Risk: destructive
webhook full type
webhook full type
get
webhooks.get
Retrieve a webhook subscription and its signing secret
Risk: read
webhook full type
webhook full type
list
webhooks.list
List webhook subscriptions configured for a mailing list
Risk: read
data full type
data full type
update
webhooks.update
Change a webhook subscription configuration
Risk: write
webhook full type
webhook full type