The Laposta connector lets your AI agent act in each user's Laposta account. Each user connects their own Laposta API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 46 tools.
- Tools
- 46
- What they doRead · write · destructive
- 19 · 20 · 719 read20 write7 destructive
- Users sign in with
- API key
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the Laposta connection
In AgentKit > Connections, create a Laposta connection. The name you give it is the
connection_nameyour code passes. See Configure connections.
Tools
Pass the exact name toexecute_toollaposta_automation_getGet one Laposta automation.Read-onlyGet Automation
Get one Laposta automation. Returns the automation object with automation_id, name, status, started count and dates. Use laposta_automations_list to find the ID.
Inputs
automation_idstringrequired- ID of the automation. Find it with laposta_automations_list. Example: pdq4k7wqcm.
laposta_automations_listList the automations in the Laposta account, optionally only active or inactive ones.Read-onlyList Automations
List the automations in the Laposta account, optionally only active or inactive ones. Deleted automations are left out. Returns data[] of automation objects with automation_id, name, status and started count. Use laposta_automation_get for one automation.
Inputs
statusstring- Only automations with this status: active or inactive. Leave empty for all.one of
activeinactive
laposta_campaign_content_getGet the HTML content of a Laposta campaign.Read-onlyGet Campaign Content
Get the HTML content of a Laposta campaign. Works only for campaigns filled with HTML or an import URL, not drag-and-drop campaigns. Returns the campaign_id, plain html and import_url. Use laposta_campaign_content_update to change it.
Inputs
campaign_idstringrequired- ID of the campaign. Find it with laposta_campaigns_list. Example: njhgaf61ye.
laposta_campaign_getGet one Laposta campaign.Read-onlyGet Campaign
Get one Laposta campaign. Returns the campaign object: name, subject, previewtext, from, reply_to, list_ids, delivery times, web version URL and screenshots. Use laposta_campaigns_list to find the campaign_id.
Inputs
campaign_idstringrequired- ID of the campaign. Find it with laposta_campaigns_list. Example: njhgaf61ye.
laposta_campaign_history_getGet the event history of a Laposta campaign: sends, opens, clicks, bounces, unsubscribes and complaints per subscriber.Read-onlyGet Campaign History
Get the event history of a Laposta campaign: sends, opens, clicks, bounces, unsubscribes and complaints per subscriber. Returns data[] of events with type, event_date, member and details, plus pagination with has_more and next_cursor. Use laposta_report_get for totals only.
Inputs
campaign_idstringrequired- ID of the campaign. Find it with laposta_campaigns_list. Example: njhgaf61ye.
cursorstring- pagination.next_cursor from the previous page, sent back unchanged. Keep the same filters when paging.
event_date_fromstring- Only events from this date and time, inclusive. Regular format YYYY-MM-DD HH:MM:SS (account timezone) or ISO 8601. Example: 2026-04-01 00:00:00.
event_date_tostring- Only events before this date and time, exclusive. Regular format YYYY-MM-DD HH:MM:SS (account timezone) or ISO 8601. Example: 2026-05-01 00:00:00.
limitinteger- Maximum events per page, 1-1000 (Laposta default 100). Example: 100.
orderstring- Sort direction, desc (default) or asc.one of
descasc order_bystring- Field to sort by. Only event_date is supported.one of
event_date
laposta_campaigns_listList the campaigns in the Laposta account, optionally only drafts or only sent ones.Read-onlyList Campaigns
List the campaigns in the Laposta account, optionally only drafts or only sent ones. Returns data[] of campaign objects with campaign_id, name, subject, from, list_ids and delivery times. Use laposta_campaign_get for one campaign and laposta_report_get for its results.
Inputs
statusstring- Only draft campaigns (not sent yet, including scheduled) or sent ones (sending or sent). Leave empty for all.one of
draftsent
laposta_field_getGet one field of a Laposta list.Read-onlyGet Field
Get one field of a Laposta list. Returns the field object: field_id, name, tag, custom_name, datatype, defaultvalue, options and options_full, required, in_form and in_list. Use laposta_fields_list to find the field_id.
Inputs
field_idstringrequired- ID of the field. Example: gt2Em8vJwi.
list_idstringrequired- ID of the Laposta list. Find it with laposta_lists_list or in the app under Subscribers > the list > Attributes list. Example: BaImMu3JZA.
laposta_fields_listList all fields of a Laposta list, including the built-in email field and the labels field if the list uses labels.Read-onlyList Fields
List all fields of a Laposta list, including the built-in email field and the labels field if the list uses labels. Returns data[] of field objects with field_id, name, custom_name, datatype, options, required, in_form and in_list. Use the custom_name values as keys in custom_fields when adding or updating subscribers.
Inputs
list_idstringrequired- ID of the Laposta list. Find it with laposta_lists_list or in the app under Subscribers > the list > Attributes list. Example: BaImMu3JZA.
laposta_list_getGet one Laposta mailing list by ID.Read-onlyGet List
Get one Laposta mailing list by ID. Returns the list object: list_id, name, state, locked, remarks, notification emails and member counts. Use laposta_lists_list to find the ID first.
Inputs
list_idstringrequired- ID of the Laposta list. Find it with laposta_lists_list or in the app under Subscribers > the list > Attributes list. Example: BaImMu3JZA.
laposta_lists_listList all mailing lists in the Laposta account.Read-onlyList Lists
List all mailing lists in the Laposta account. Returns data[] of list objects with list_id, name, state, locked, remarks and member counts (active, unsubscribed, cleaned). Use laposta_lists_list to find a list_id. Use laposta_list_get for one list.
Inputs
This tool takes no inputs.
laposta_member_getGet one subscriber of a Laposta list by member ID or email address.Read-onlyGet Subscriber
Get one subscriber of a Laposta list by member ID or email address. Returns the member object: member_id, email, state, signup and confirm dates, ip, source_url and custom_fields. Use laposta_members_list to search a list.
Inputs
list_idstringrequired- ID of the Laposta list. Find it with laposta_lists_list or in the app under Subscribers > the list > Attributes list. Example: BaImMu3JZA.
member_idstringrequired- Member ID or the subscriber's email address. Write a + in an email address as %2B. Example: Du83Hyjhj8.
laposta_member_history_getGet the event history of a Laposta subscriber: subscriptions, sends, opens, clicks, bounces and automation steps.Read-onlyGet Subscriber History
Get the event history of a Laposta subscriber: subscriptions, sends, opens, clicks, bounces and automation steps. Returns data[] of events with type, event_date, campaign and details, plus pagination with has_more and next_cursor. Use laposta_campaign_history_get for all events of one campaign.
Inputs
list_idstringrequired- ID of the Laposta list. Find it with laposta_lists_list or in the app under Subscribers > the list > Attributes list. Example: BaImMu3JZA.
member_idstringrequired- Member ID or the subscriber's email address. Example: Du83Hyjhj8.
campaign_idstring- Only events of this campaign. Leave empty for the full history. Example: njhgaf61ye.
cursorstring- pagination.next_cursor from the previous page, sent back unchanged. Keep the same filters when paging.
event_date_fromstring- Only events from this date and time, inclusive. Regular format YYYY-MM-DD HH:MM:SS (account timezone) or ISO 8601. Example: 2026-04-01 00:00:00.
event_date_tostring- Only events before this date and time, exclusive. Regular format YYYY-MM-DD HH:MM:SS (account timezone) or ISO 8601. Example: 2026-05-01 00:00:00.
limitinteger- Maximum events per page, 1-1000 (Laposta default 100). Example: 100.
orderstring- Sort direction, desc (default) or asc.one of
descasc order_bystring- Field to sort by. Only event_date is supported.one of
event_date
laposta_members_listList subscribers of a Laposta list, optionally by state, label or search term, in pages when limit or cursor is sent.Read-onlyList Subscribers
List subscribers of a Laposta list, optionally by state, label or search term, in pages when limit or cursor is sent. Returns data[] of member objects (member_id, email, state, signup_date, custom_fields) and, when paged, a pagination object with next_cursor. Use laposta_member_get for one subscriber by ID or email.
Inputs
list_idstringrequired- ID of the Laposta list. Find it with laposta_lists_list or in the app under Subscribers > the list > Attributes list. Example: BaImMu3JZA.
cursorstring- pagination.next_cursor from the previous page, sent back unchanged with the same other filters.
labelstring- Only subscribers carrying this label, by exact name. One label per request. Example: Customer.
limitinteger- Subscribers per page, up to 1000 (default 100). Sending limit or cursor switches to paged results; without either the whole list comes back at once. Example: 100.
orderstring- Sort direction for order_by: asc (default) or desc.one of
ascdesc order_bystring- Sort by email, signup_date or a text field's tag without braces; comma-separate several. Example: lastname,firstname.
searchstring- Only subscribers whose email or text, numeric or select field values contain this text (case-insensitive, up to 255 characters). Example: example.net.
statestring- Only subscribers with this status: active, unsubscribed or cleaned.one of
activeunsubscribedcleaned
laposta_report_getGet the results of one Laposta campaign.Read-onlyGet Campaign Report
Get the results of one Laposta campaign. Returns sent, accepted, opened, clicked, webversion, cleaned, complained, hardbounced and unsubscribed counts, unique counts and ratios. Use laposta_campaign_history_get for per-subscriber events.
Inputs
campaign_idstringrequired- ID of the campaign. Find it with laposta_campaigns_list. Example: njhgaf61ye.
laposta_reports_listGet the results of all campaigns in the Laposta account.Read-onlyList Campaign Reports
Get the results of all campaigns in the Laposta account. Returns data[] of report objects per campaign with sent, accepted, opened, clicked, bounced, unsubscribed and complained counts and ratios. Use laposta_report_get for one campaign.
Inputs
This tool takes no inputs.
laposta_segment_getGet one segment of a Laposta list.Read-onlyGet Segment
Get one segment of a Laposta list. Returns the segment object with segment_id, name and its definition (a JSON string). Copy a definition built in the app to create similar segments with laposta_segment_create.
Inputs
list_idstringrequired- ID of the Laposta list. Find it with laposta_lists_list or in the app under Subscribers > the list > Attributes list. Example: BaImMu3JZA.
segment_idstringrequired- ID of the segment. Example: pDrp5KOD0z.
laposta_segments_listList all segments of a Laposta list.Read-onlyList Segments
List all segments of a Laposta list. Returns data[] of segment objects with segment_id, name and definition. Use laposta_segment_get for one segment.
Inputs
list_idstringrequired- ID of the Laposta list. Find it with laposta_lists_list or in the app under Subscribers > the list > Attributes list. Example: BaImMu3JZA.
laposta_webhook_getGet one webhook of a Laposta list.Read-onlyGet Webhook
Get one webhook of a Laposta list. Returns the webhook object: webhook_id, event, url, blocked, state and secret for verifying X-Laposta-Signature. Use laposta_webhooks_list to find the webhook_id.
Inputs
list_idstringrequired- ID of the Laposta list. Find it with laposta_lists_list or in the app under Subscribers > the list > Attributes list. Example: BaImMu3JZA.
webhook_idstringrequired- ID of the webhook. Example: cW5ls8IVJl.
laposta_webhooks_listList the webhooks of a Laposta list.Read-onlyList Webhooks
List the webhooks of a Laposta list. Returns data[] of webhook objects with webhook_id, event, url, blocked, state and signing secret. Use laposta_webhook_get for one webhook.
Inputs
list_idstringrequired- ID of the Laposta list. Find it with laposta_lists_list or in the app under Subscribers > the list > Attributes list. Example: BaImMu3JZA.
laposta_automation_refreshActivate the changes made to an active Laposta automation since it was last activated, like the Activate changes button in the app.WriteActivate Automation Changes
Activate the changes made to an active Laposta automation since it was last activated, like the Activate changes button in the app. Returns the automation object; on a failed check the previous version keeps running and the error lists each problem. Use laposta_automation_start for an inactive automation.
Inputs
automation_idstringrequired- ID of the automation. Find it with laposta_automations_list. Example: pdq4k7wqcm.
laposta_automation_startActivate an inactive Laposta automation, like the Activate button in the app.WriteStart Automation
Activate an inactive Laposta automation, like the Activate button in the app. It is checked first and stays inactive if something is wrong. Returns the automation object, or an error whose details list each problem. Use laposta_automation_refresh to activate changes to an automation that is already active.
Inputs
automation_idstringrequired- ID of the automation. Find it with laposta_automations_list. Example: pdq4k7wqcm.
laposta_automation_stopPause an active Laposta automation, like the Pause button in the app.WriteStop Automation
Pause an active Laposta automation, like the Pause button in the app. Members stay where they are and continue when it is started again. Returns the automation object. Use laposta_automation_start to resume.
Inputs
automation_idstringrequired- ID of the automation. Find it with laposta_automations_list. Example: pdq4k7wqcm.
laposta_campaign_content_updateFill a Laposta campaign with HTML, or import the HTML from a URL.WriteSet Campaign Content
Fill a Laposta campaign with HTML, or import the HTML from a URL. If both are given, html is used. Returns the content with a report of import problems such as no_unsubscribe, css or images. Run this after laposta_campaign_create and before sending; Laposta adds an unsubscribe link if the HTML has none.
- Idempotent
Inputs
campaign_idstringrequired- ID of the campaign. Find it with laposta_campaigns_list. Example: njhgaf61ye.
htmlstring- Full HTML of the email. Required unless import_url is given. Example: <html><body><h1>News</h1></body></html>.
import_urlstring- URL Laposta imports the HTML from. Required unless html is given. Example: https://example.net/newsletter.
inline_cssboolean- Move CSS inline into the HTML elements. true or false.
laposta_campaign_createCreate a regular email campaign in Laposta with its sender, subject and recipient lists.WriteCreate Campaign
Create a regular email campaign in Laposta with its sender, subject and recipient lists. Returns the new campaign object with its campaign_id. Next fill it with laposta_campaign_content_update, then send it with laposta_campaign_send or laposta_campaign_schedule.
Inputs
from_emailstringrequired- Sender email address. It must be a sender address approved in the Laposta app. Example: max@example.net.
from_namestringrequired- Sender name, up to 255 characters. Example: Max de Vries.
list_idsarrayrequired- Recipients: IDs of lists, and of segments if needed. Example: ["nnhnkrytua", "srbhotdwob"].
namestringrequired- Internal campaign name, up to 255 characters. Example: Test via API.
subjectstringrequired- Email subject line, up to 255 characters. Example: Hello from us.
typestringrequired- Campaign type. Only regular is supported.one of
regular previewtextstring- Preview text shown after the subject in many inboxes, up to 120 characters. Example: Our news of this month.
reply_tostring- Email address that receives replies. Example: reply@example.net.
stats_gaboolean- Link Google Analytics to the campaign's links. true or false.
laposta_campaign_scheduleSchedule a Laposta campaign for a later date and time.WriteSchedule Campaign
Schedule a Laposta campaign for a later date and time. Returns the campaign object with delivery_requested set. Use laposta_campaign_send to send right away.
Inputs
campaign_idstringrequired- ID of the campaign. Find it with laposta_campaigns_list. Example: njhgaf61ye.
delivery_requestedstringrequired- When to send. Regular format YYYY-MM-DD HH:MM:SS (account timezone) or ISO 8601. Example: 2026-12-01 09:00:00.
laposta_campaign_sendSend a Laposta campaign right away to its lists.WriteSend Campaign
Send a Laposta campaign right away to its lists. A campaign sent before is sent again only to subscribers added since the last send. Returns the campaign object. Use laposta_campaign_schedule to send later and laposta_campaign_testmail to test first.
Inputs
campaign_idstringrequired- ID of the campaign. Find it with laposta_campaigns_list. Example: njhgaf61ye.
laposta_campaign_testmailSend a test email of an unsent Laposta campaign that already has content.WriteSend Campaign Test
Send a test email of an unsent Laposta campaign that already has content. Returns the campaign object. Use before laposta_campaign_send to check the email.
Inputs
campaign_idstringrequired- ID of the campaign. Find it with laposta_campaigns_list. Example: njhgaf61ye.
emailstringrequired- Address to send the test to. Example: test@example.net.
laposta_campaign_updateChange the name, subject, sender, reply-to address or recipients of a Laposta campaign.WriteUpdate Campaign
Change the name, subject, sender, reply-to address or recipients of a Laposta campaign. Only the fields you send change. Returns the updated campaign object. Use laposta_campaign_content_update to change the email body.
- Idempotent
Inputs
campaign_idstringrequired- ID of the campaign. Find it with laposta_campaigns_list. Example: njhgaf61ye.
from_emailstring- Sender email address. It must be a sender address approved in the Laposta app. Example: max@example.net.
from_namestring- Sender name, up to 255 characters. Example: Max de Vries.
list_idsarray- Recipients: IDs of lists, and of segments if needed. Example: ["nnhnkrytua", "srbhotdwob"].
namestring- Internal campaign name, up to 255 characters. Example: Test via API.
previewtextstring- Preview text shown after the subject in many inboxes, up to 120 characters. Example: Our news of this month.
reply_tostring- Email address that receives replies. Example: reply@example.net.
stats_gaboolean- Link Google Analytics to the campaign's links. true or false.
subjectstring- Email subject line, up to 255 characters. Example: Hello from us.
laposta_field_createAdd an extra subscriber field to a Laposta list.WriteCreate Field
Add an extra subscriber field to a Laposta list. Returns the new field object, with its custom_name for use in custom_fields. The labels field cannot be created through the API.
Inputs
datatypestringrequired- Data type: text, numeric, date, select_single or select_multiple.one of
textnumericdateselect_singleselect_multiple in_formbooleanrequired- Whether the field appears in the subscription form. true or false.
in_listbooleanrequired- Whether the field is shown in Laposta's subscriber overview. true or false.
list_idstringrequired- ID of the Laposta list. Find it with laposta_lists_list or in the app under Subscribers > the list > Attributes list. Example: BaImMu3JZA.
namestringrequired- Display name of the field. Example: Color.
requiredbooleanrequired- Whether subscribers must fill in this field. true or false.
datatype_displaystring- Display style: select or radio for select_single; input (one line, up to 255 characters) or textarea (up to 10,000 characters) for text.one of
selectradioinputtextarea defaultvaluestring- Default value used when the field is left empty. Example: Green.
optionsarray- Selectable options; required for select_single and select_multiple. Example: ["Red", "Green", "Blue"].
laposta_field_updateChange a field of a Laposta list.WriteUpdate Field
Change a field of a Laposta list. Only the parts you send change; changing the datatype erases the field's data. Returns the updated field object. To change select options send options_full with every option to keep; the labels field cannot be changed.
- Idempotent
Inputs
field_idstringrequired- ID of the field to change. Example: hsJ5zbDfzJ.
list_idstringrequired- ID of the Laposta list. Find it with laposta_lists_list or in the app under Subscribers > the list > Attributes list. Example: BaImMu3JZA.
datatypestring- New data type. Changing it removes all data stored in the field.one of
textnumericdateselect_singleselect_multiple datatype_displaystring- Display style: select or radio for select_single; input (one line, up to 255 characters) or textarea (up to 10,000 characters) for text.one of
selectradioinputtextarea defaultvaluestring- Default value used when the field is left empty. Example: Green.
in_formboolean- Whether the field appears in the subscription form. true or false.
in_listboolean- Whether the field is shown in Laposta's subscriber overview. true or false.
namestring- New display name. Example: Favourite color.
options_fullobject- Complete set of options for a select field as a map of option ID to label. Keep an existing numeric ID to keep or rename that option, use a non-numeric key such as new-0 to add one, and leave an ID out to delete it. Example: {"1": "Red", "2": "Lime Green", "new-0": "Orange"}.
requiredboolean- Whether subscribers must fill in this field. true or false.
laposta_list_createCreate a new Laposta mailing list.WriteCreate List
Create a new Laposta mailing list. Returns the new list object with its list_id. Add extra subscriber fields afterwards with laposta_field_create.
Inputs
namestringrequired- Name of the list. Example: Testlist.
lockedboolean- Lock the list so users of the Laposta app cannot change it. true or false.
remarksstring- Free-text remarks about the list. Example: A list for testing purposes.
subscribe_notification_emailstring- Email address that gets a notification on each new subscription. Example: subscription@example.net.
unsubscribe_notification_emailstring- Email address that gets a notification on each unsubscription. Example: unsubscription@example.net.
laposta_list_members_syncAdd, update and optionally unsubscribe many subscribers of a Laposta list in one request (paid accounts only).WriteBulk Sync List Members
Add, update and optionally unsubscribe many subscribers of a Laposta list in one request (paid accounts only). Returns a report that sorts each submitted member into added, edited, skipped and errors. Use laposta_member_create or laposta_member_update for a single subscriber. Including unsubscribe_excluded unsubscribes every member not in the request.
Inputs
actionsarrayrequired- What the sync may do: add (new members), update (existing members) and/or unsubscribe_excluded (unsubscribe every active member NOT in members; only send this with the complete member list). Example: ["add", "update"].
list_idstringrequired- ID of the Laposta list. Find it with laposta_lists_list or in the app under Subscribers > the list > Attributes list. Example: BaImMu3JZA.
membersarrayrequired- Member objects, 1 to 500,000. Each needs an email or a member_id (the ID or email of an existing member, with email then giving a new address), and may carry custom_fields (keyed by custom_name), source_url and state. Example: [{"email": "maartje@example.net", "custom_fields": {"name": "Maartje"}}].
laposta_list_updateChange the name, lock, remarks or notification addresses of a Laposta list.WriteUpdate List
Change the name, lock, remarks or notification addresses of a Laposta list. Only the fields you send change. Returns the updated list object. Use laposta_list_get to read the current values.
- Idempotent
Inputs
list_idstringrequired- ID of the Laposta list. Find it with laposta_lists_list or in the app under Subscribers > the list > Attributes list. Example: BaImMu3JZA.
lockedboolean- Lock the list so users of the Laposta app cannot change it. true or false.
namestring- New name for the list. Example: Customers.
remarksstring- Free-text remarks about the list. Example: A list for testing purposes.
subscribe_notification_emailstring- Email address that gets a notification on each new subscription. Example: subscription@example.net.
unsubscribe_notification_emailstring- Email address that gets a notification on each unsubscription. Example: unsubscription@example.net.
laposta_member_createAdd a subscriber to a Laposta list.WriteAdd Subscriber
Add a subscriber to a Laposta list. On a double opt-in list a confirmation email is sent unless options.ignore_doubleoptin is true. Returns the new member object with its member_id. Set options.upsert to update an existing subscriber instead of getting an error; use laposta_list_members_sync for many at once.
Inputs
emailstringrequired- Email address of the subscriber. Example: maartje@example.net.
ipstringrequired- IP address the subscriber signed up from. Use your server's IP for API imports. Example: 198.51.100.0.
list_idstringrequired- ID of the Laposta list. Find it with laposta_lists_list or in the app under Subscribers > the list > Attributes list. Example: BaImMu3JZA.
custom_fieldsobject- Values for the list's extra fields, keyed by each field's custom_name (see laposta_fields_list). Multi-select fields and labels take an array of existing option or label names. Example: {"name": "Maartje de Vries", "children": 2, "prefs": ["optionA", "optionB"]}.
optionsobject- Extra instructions, each true or false: upsert (update the subscriber if the email is already on the list, which also reactivates an unsubscribed one), suppress_reactivation (with upsert, keep unsubscribed subscribers unsubscribed), suppress_email_notification, ignore_doubleoptin (activate right away with no confirmation email) and spam_check (treat as a public form submission). Example: {"upsert": true, "ignore_doubleoptin": true}.
source_urlstring- URL the subscriber signed up from. Example: https://example.com/signup.
user_agentstring- The subscriber's browser User-Agent, used only by the spam check. Example: Mozilla/5.0.
laposta_member_updateChange a Laposta subscriber's email, state or custom fields.WriteUpdate Subscriber
Change a Laposta subscriber's email, state or custom fields. Only the fields you send change. Returns the updated member object. Set state to unsubscribed to unsubscribe; labels in custom_fields replace the subscriber's current labels.
- Idempotent
Inputs
list_idstringrequired- ID of the Laposta list. Find it with laposta_lists_list or in the app under Subscribers > the list > Attributes list. Example: BaImMu3JZA.
member_idstringrequired- Member ID or the subscriber's current email address. Example: 9978ydioiZ.
custom_fieldsobject- Values for the list's extra fields, keyed by each field's custom_name (see laposta_fields_list). Multi-select fields and labels take an array of existing option or label names. Example: {"name": "Maartje de Vries", "children": 2, "prefs": ["optionA", "optionB"]}.
emailstring- New email address. Example: maartje.new@example.net.
statestring- New status: active or unsubscribed.one of
activeunsubscribed
laposta_segment_createCreate a segment of a Laposta list from a definition.WriteCreate Segment
Create a segment of a Laposta list from a definition. Returns the new segment object with its segment_id. Build the segment in the Laposta app first and copy its definition from laposta_segment_get; definitions are hard to write by hand.
Inputs
definitionstringrequired- Segment definition as Laposta stores it, a string in JSON format; copy it from laposta_segment_get. Example: {"postcode"} = '1234AB'.
list_idstringrequired- ID of the Laposta list. Find it with laposta_lists_list or in the app under Subscribers > the list > Attributes list. Example: BaImMu3JZA.
namestringrequired- Name of the segment. Example: Contacts with postal code 1234AB.
laposta_segment_updateChange the name or definition of a Laposta segment.WriteUpdate Segment
Change the name or definition of a Laposta segment. Only the fields you send change. Returns the updated segment object. Use laposta_segment_get to read the current definition.
- Idempotent
Inputs
list_idstringrequired- ID of the Laposta list. Find it with laposta_lists_list or in the app under Subscribers > the list > Attributes list. Example: BaImMu3JZA.
segment_idstringrequired- ID of the segment to change. Example: pDrp5KOD0z.
definitionstring- New segment definition, a string in JSON format as returned by laposta_segment_get.
namestring- New name of the segment. Example: Contacts in Amsterdam.
laposta_webhook_createRegister a webhook that Laposta POSTs to when subscribers of a list are added, changed or deactivated.WriteCreate Webhook
Register a webhook that Laposta POSTs to when subscribers of a list are added, changed or deactivated. Returns the new webhook object with its webhook_id and signing secret. Webhooks are not called for changes made through the API unless enabled in the account.
Inputs
blockedbooleanrequired- Create the webhook paused (true) or active (false).
eventstringrequired- When to call the webhook: subscribed, modified or deactivated.one of
subscribedmodifieddeactivated list_idstringrequired- ID of the Laposta list. Find it with laposta_lists_list or in the app under Subscribers > the list > Attributes list. Example: BaImMu3JZA.
urlstringrequired- URL Laposta POSTs the events to. Example: https://example.com/webhook.
laposta_webhook_updateChange the event, URL or blocked status of a Laposta webhook.WriteUpdate Webhook
Change the event, URL or blocked status of a Laposta webhook. Only the fields you send change. Returns the updated webhook object. Set blocked to true to pause a webhook without deleting it.
- Idempotent
Inputs
list_idstringrequired- ID of the Laposta list. Find it with laposta_lists_list or in the app under Subscribers > the list > Attributes list. Example: BaImMu3JZA.
webhook_idstringrequired- ID of the webhook to change. Example: JH_y9dEsfH.
blockedboolean- true pauses the webhook, false resumes it.
eventstring- When to call the webhook: subscribed, modified or deactivated.one of
subscribedmodifieddeactivated urlstring- New URL for the webhook. Example: https://example.com/dir/webhook.
laposta_campaign_deleteDelete a Laposta campaign.DestructiveDelete Campaign
Delete a Laposta campaign. Unsent campaigns are deleted at once; sent ones can be restored in the app for 180 days. Returns the campaign object with state deleted. Use laposta_campaigns_list to find the campaign_id.
- Idempotent
Inputs
campaign_idstringrequired- ID of the campaign to delete. Example: az0ndh7akc.
laposta_field_deletePermanently delete a field from a Laposta list, with its data.DestructiveDelete Field
Permanently delete a field from a Laposta list, with its data. Returns the field object with state deleted. The labels field cannot be deleted through the API.
- Idempotent
Inputs
field_idstringrequired- ID of the field to delete. Example: lxwc8OyD3a.
list_idstringrequired- ID of the Laposta list. Find it with laposta_lists_list or in the app under Subscribers > the list > Attributes list. Example: BaImMu3JZA.
laposta_list_deletePermanently delete a Laposta list and its subscribers.DestructiveDelete List
Permanently delete a Laposta list and its subscribers. Returns the list object with state deleted. Use laposta_list_members_purge to empty a list but keep it.
- Idempotent
Inputs
list_idstringrequired- ID of the Laposta list. Find it with laposta_lists_list or in the app under Subscribers > the list > Attributes list. Example: BaImMu3JZA.
laposta_list_members_purgePermanently remove all active subscribers from a Laposta list, keeping the list itself.DestructivePurge List Members
Permanently remove all active subscribers from a Laposta list, keeping the list itself. Returns the list object. Use laposta_list_delete to remove the list too.
- Idempotent
Inputs
list_idstringrequired- ID of the Laposta list. Find it with laposta_lists_list or in the app under Subscribers > the list > Attributes list. Example: BaImMu3JZA.
laposta_member_deletePermanently delete a subscriber from a Laposta list.DestructiveDelete Subscriber
Permanently delete a subscriber from a Laposta list. Returns the member object with state deleted. Use laposta_member_update with state unsubscribed to unsubscribe instead.
- Idempotent
Inputs
list_idstringrequired- ID of the Laposta list. Find it with laposta_lists_list or in the app under Subscribers > the list > Attributes list. Example: BaImMu3JZA.
member_idstringrequired- Member ID or the subscriber's email address. Example: 9978ydioiZ.
laposta_segment_deletePermanently delete a segment of a Laposta list.DestructiveDelete Segment
Permanently delete a segment of a Laposta list. Subscribers are not affected. Returns the deleted segment object. Use laposta_segments_list to find the segment_id.
- Idempotent
Inputs
list_idstringrequired- ID of the Laposta list. Find it with laposta_lists_list or in the app under Subscribers > the list > Attributes list. Example: BaImMu3JZA.
segment_idstringrequired- ID of the segment to delete. Example: pDrp5KOD0z.
laposta_webhook_deletePermanently delete a webhook of a Laposta list.DestructiveDelete Webhook
Permanently delete a webhook of a Laposta list. Calls already queued are still delivered. Returns the webhook object with state deleted. Use laposta_webhook_update with blocked true to pause instead.
- Idempotent
Inputs
list_idstringrequired- ID of the Laposta list. Find it with laposta_lists_list or in the app under Subscribers > the list > Attributes list. Example: BaImMu3JZA.
webhook_idstringrequired- ID of the webhook to delete. Example: 8HdlEGtlml.
No tools match.