Skip to main content
New to Corsair? See API access, authentication, and error handling.

Campaigns

create

campaigns.create Create a regular email campaign Risk: write
Input
Output

delete

campaigns.delete Delete an unsent or previously sent campaign Risk: destructive
Input Output

get

campaigns.get Retrieve a specific campaign by ID Risk: read
Input Output

get_content

campaigns.get_content Retrieve the HTML and plaintext campaign content Risk: read
Input Output

history

campaigns.history Retrieve paginated events for a campaign Risk: read
Input Campaign history uses cursor pagination with a default limit of 100 and maximum of 1000. Keep the same filters and ordering when sending the next cursor. Output

list

campaigns.list Retrieve all email campaigns Risk: read
Input Use limit (1–1000) and cursor to page through campaigns. status may be draft or sent. Output

schedule

campaigns.schedule Schedule campaign delivery to its configured recipients Risk: destructive
Input Scheduling starts email delivery at the specified time; a campaign sent before may be rescheduled for members added since its previous send. Output

send

campaigns.send Send a campaign to its configured recipients Risk: destructive
Input This sends the campaign to configured recipients. A previously sent campaign may be sent again to members added since its previous send. Output

send_test

campaigns.send_test Send a campaign test email to the specified address Risk: destructive
Input This sends an actual test email, and only works when content exists for a campaign that has not yet been sent. Output

update

campaigns.update Update campaign metadata and recipients Risk: write
Input
Output

update_content

campaigns.update_content Set campaign content from HTML or an import URL Risk: write
Input Provide 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

Fields

create

fields.create Create a new custom field for a mailing list Risk: write
Input The required, in_form, and in_list booleans are mandatory. Select fields need at least one option. Output

delete

fields.delete Delete a custom field from a mailing list Risk: destructive
Input Output

get

fields.get Retrieve a specific custom field by ID Risk: read
Input Output

list

fields.list Retrieve custom fields for a mailing list Risk: read
Input Output

update

fields.update Update a custom field; changing its datatype removes stored values Risk: destructive
Input Laposta requires 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.
Output

Lists

create

lists.create Create a new mailing list Risk: write
Input Output

delete

lists.delete Delete a mailing list Risk: destructive
Input Output

get

lists.get Retrieve a specific mailing list by ID Risk: read
Input Output

list

lists.list Retrieve all mailing lists Risk: read
Input: empty object Output

purge_members

lists.purge_members Permanently remove every active member from a mailing list Risk: destructive
Input Output

sync_members

lists.sync_members Add, update, or bulk-unsubscribe members in a mailing list Risk: destructive
Input This bulk endpoint is available only to paid accounts and requires JSON. The unsubscribe_excluded action unsubscribes every current member omitted from the submitted list; double-check the complete member set before using it.
Output

update

lists.update Update an existing mailing list Risk: write
Input Output

Members

create

members.create Subscribe a member, which may send a confirmation email Risk: destructive
Input The ip is mandatory. On a double-opt-in list Laposta can send a confirmation email; options.ignore_doubleoptin disables that confirmation behavior.
Output

delete

members.delete Unsubscribe or delete a member from a list Risk: destructive
Input Output

get

members.get Retrieve a specific subscriber by ID Risk: read
Input Output

history

members.history Retrieve a member event history with cursor pagination Risk: read
Input History uses cursor pagination with a default limit of 100 and maximum of 1000. Keep the same filters and order when sending the next cursor. Output

list

members.list Retrieve subscribers for a mailing list Risk: read
Input Use 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

update

members.update Update an existing subscriber Risk: write
Input Pass an empty array for a multiselect custom field to clear its current value. Laposta requires the field to be present in the form body with no assigned value. Output

Reports

get

reports.get Retrieve analytics and delivery report for a campaign Risk: read
Input Output

list

reports.list Retrieve paginated delivery reports for campaigns Risk: read
Input Use limit (1–1000) and cursor to page through campaign reports. Output

Segments

create

segments.create Create a segment for a mailing list Risk: write
Input The definition is a JSON string of selection blocks and rules, for example {"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

delete

segments.delete Permanently delete a mailing-list segment Risk: destructive
Input Output

get

segments.get Retrieve one mailing-list segment and its definition Risk: read
Input Output

list

segments.list Retrieve all segments belonging to a mailing list Risk: read
Input Output

update

segments.update Change a segment name or definition Risk: write
Input Output

Webhooks

create

webhooks.create Create a webhook subscription for a mailing list Risk: write
Input Creates a Laposta subscription that POSTs member events to the configured URL. This operation manages the subscription; it does not install an incoming request handler. Output

delete

webhooks.delete Permanently delete a webhook subscription Risk: destructive
Input Output

get

webhooks.get Retrieve a webhook subscription and its signing secret Risk: read
Input Laposta returns the webhook signing secret in the webhook object. Keep it private; the plugin does not include it in logs. Output

list

webhooks.list List webhook subscriptions configured for a mailing list Risk: read
Input Output

update

webhooks.update Change a webhook subscription configuration Risk: write
Input Output