Skip to main content

Systeme

Systeme.io is an all-in-one marketing platform for building sales funnels, sending email campaigns, and hosting online courses, communities, and memberships. The Systeme connector reads contacts, tags, funnels, newsletters, campaigns, automation emails and email statistics, automation rules, courses, communities, products, offers, coupons, bookings, SMS templates, and webhooks, and can create, update, and delete most of them, send newsletters, and enroll contacts in courses.

Systeme icon

Power end-to-end data operations for your Systeme API with Nexla. Our bi-directional Systeme connector is purpose-built for Systeme, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to Systeme or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Systeme workflows fast, secure, and fully governed.

Features

Type: API

SourceDestination

  • Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
  • Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
  • API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
  • Request optimization with intelligent batching, retry, and caching to minimize API calls and costs

Prerequisites​

Nexla connects to the Systeme.io Public API with a public API key from your Systeme.io account. Systeme authenticates every request with this key, sent in the X-API-Key request header. To create a key:

  1. Sign in to your Systeme.io account.

  2. Click your profile picture, and select Settings.

  3. In the left menu, select MCP & API keys.

  4. In the Public API keys section, click Create.

  5. Enter a unique name for the key and, optionally, an expiration date and time. Leave the Expiration field empty to keep the key active indefinitely, and click Save.

  6. Copy the key immediately. Systeme shows the key only once, right after you create it; if you did not copy it, delete the key and create a new one.

An account can hold up to three public API keys, and Systeme sends an email notification each time a key is created. The key gives access to all of your account's data, so keep it confidential. For details, see Systeme's How to use the systeme.io public API help article.

Systeme API rate limits

Systeme applies a rate limit that is shared by all of the API keys on your account. Requests over the limit receive an HTTP 429 Too Many Requests response with a Retry-After header. Templates that page through large collections, such as contacts, make one request per page of 100 records. See the rate-limiting section of the Systeme Public API documentation for details.

Authenticate​

Credentials required​

An authentication method that requires sending a unique secret token with each API request

FieldRequiredSecretDescription
API Key ValueYesYesAn encoded string value used as a secret token to authenticate API requests

Create a credential in Nexla​

  1. After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

  2. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

  3. Enter your Systeme public API key in the API Key Value field. This is the key you created in Prerequisites. Nexla sends it in the X-API-Key header of every request to the Systeme API.

    If your API key is compromised, delete it in Systeme under Settings > MCP & API keys, create a new one, and update the API Key Value on this credential.

  4. Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation.

Nexla tests the credential by reading the contact list from your Systeme account.

Use as a data source​

To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the Systeme connector tile, then select the credential that will be used to connect to your Systeme account, and click Next; or, create a new Systeme credential for use in this flow.

Endpoint templates​

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Systeme endpoints. Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below, grouped by area.

Templates that say "Results are paged automatically" read every page, 100 records at a time, by passing the ID of the last record on each page to the next request. Templates that need an ID, such as a contact or course ID, read one object; use the matching list template to find the ID.

Contacts, tags, and fields​

Retrieve contact collection

Lists all contacts in the Systeme account, including each contact's ID, email address, field values, tags, and registration date. Results are paged automatically.

Retrieve a single contact

Retrieves one contact by ID, including its field values and tags.

  • Enter the Id. Use the Retrieve contact collection template to find it.

List Contact Subscriptions

Lists the payment subscriptions of one contact. Results are paged automatically.

  • Enter the Contact ID. Use the Retrieve contact collection template to find it.
  • See the Systeme API reference for the response fields.

Retrieve tag collection

Lists all tags defined in the account with their IDs and names. Results are paged automatically.

Retrieve a single tag

Retrieves one tag by ID.

  • Enter the Id. Use the Retrieve tag collection template to find it.

Retrieve contact field collection

Lists the contact fields configured in the account, including each field's name and slug. Results are read in a single request.

Funnels and pages​

Retrieve funnel collection

Lists all funnels in the account. Results are paged automatically.

Retrieve a single funnel

Retrieves one funnel by ID.

  • Enter the Id. Use the Retrieve funnel collection template to find it.

Retrieve funnel steps collection

Lists the steps of one funnel. Results are paged automatically.

  • Enter the Id. Use the Retrieve funnel collection template to find it.
  • See the Systeme API reference for the response fields.

List All Funnel Steps

Lists funnel steps across all funnels. Results are paged automatically.

Retrieve a single funnel step

Retrieves one funnel step by ID.

  • Enter the Id. Use the List All Funnel Steps template to find it.

Get Sale Settings

Retrieves a funnel's sale settings, such as currency, payment methods, and tax.

  • Enter the sale settings external UUID returned by a funnel.
  • See the Systeme API reference for the response fields.

List Payment Methods

Lists the payment methods available for a sale currency.

  • Select the Currency as a lowercase ISO code. The default is usd.
  • See the Systeme API reference for the response fields.

Email marketing​

Retrieve newsletter collection

Lists newsletters (broadcast emails). Results are paged automatically.

Retrieve a single newsletter

Retrieves one newsletter by ID.

  • Enter the Id. Use the Retrieve newsletter collection template to find it.

Get Newsletter Schedule

Retrieves when a newsletter is scheduled to send.

  • Enter the ID. Use the Retrieve newsletter collection template to find it.
  • See the Systeme API reference for the response fields.

List Newsletter Included Tags

Lists the tags a newsletter is sent to. Results are paged automatically.

  • Enter the ID. Use the Retrieve newsletter collection template to find it.
  • See the Systeme API reference for the response fields.

List Newsletter Excluded Tags

Lists the tags excluded from a newsletter's audience. Results are paged automatically.

  • Enter the ID. Use the Retrieve newsletter collection template to find it.
  • See the Systeme API reference for the response fields.

Get Newsletter Statistics

Retrieves the delivery statistics of one newsletter.

  • Enter the ID. Use the Retrieve newsletter collection template to find it.
  • See the Systeme API reference for the response fields.

List Newsletter Statistics

Lists statistics per newsletter for a send-date range of up to 31 days. Systeme marks this API as beta. Returns at most the first 100 rows.

  • Enter the Date From and Date To of the send-date range, in YYYY-MM-DD format in the account's time zone. The range can span at most 31 days, and Date To cannot be in the future. The defaults, {now-30} and {now}, cover the last 30 days.
  • See the Systeme API reference for the response fields.

Get Newsletter Statistics Summary

Retrieves total and per-day newsletter statistics for a send-date range of up to 31 days.

  • Enter the Date From and Date To of the send-date range, in YYYY-MM-DD format in the account's time zone. The range can span at most 31 days, and Date To cannot be in the future. The defaults, {now-30} and {now}, cover the last 30 days.
  • See the Systeme API reference for the response fields.

List Campaigns

Lists email campaigns (sequences). Results are paged automatically.

Get Campaign

Retrieves one email campaign by ID.

  • Enter the ID. Use the List Campaigns template to find it.
  • See the Systeme API reference for the response fields.

List Campaign Steps

Lists the steps (emails) of one campaign. Results are read in a single request.

  • Enter the Campaign ID. Use the List Campaigns template to find it.
  • See the Systeme API reference for the response fields.

Get Campaign Step

Retrieves one campaign step, including its content and activation settings.

  • Enter the ID. Use the List Campaign Steps template to find it.
  • See the Systeme API reference for the response fields.

Get Campaign Step Statistics

Retrieves the delivery statistics of one campaign step.

  • Enter the ID. Use the List Campaign Steps template to find it.
  • See the Systeme API reference for the response fields.

List Campaign Step Statistics

Lists statistics per campaign step for a send-date range of up to 31 days. Systeme marks this API as beta. Returns at most the first 100 rows.

  • Enter the Date From and Date To of the send-date range, in YYYY-MM-DD format in the account's time zone. The range can span at most 31 days, and Date To cannot be in the future. The defaults, {now-30} and {now}, cover the last 30 days.
  • See the Systeme API reference for the response fields.

Get Campaign Step Statistics Summary

Retrieves total and per-day campaign step statistics for a send-date range of up to 31 days.

  • Enter the Date From and Date To of the send-date range, in YYYY-MM-DD format in the account's time zone. The range can span at most 31 days, and Date To cannot be in the future. The defaults, {now-30} and {now}, cover the last 30 days.
  • See the Systeme API reference for the response fields.

List Automation Emails

Lists automation emails. Results are paged automatically.

Get Automation Email

Retrieves one automation email, including its content.

  • Enter the ID. Use the List Automation Emails template to find it.
  • See the Systeme API reference for the response fields.

Get Automation Email Statistics

Retrieves the delivery statistics of one automation email.

  • Enter the ID. Use the List Automation Emails template to find it.
  • See the Systeme API reference for the response fields.

List Automation Email Statistics

Lists statistics per automation email for a send-date range of up to 31 days. Systeme marks this API as beta. Returns at most the first 100 rows.

  • Enter the Date From and Date To of the send-date range, in YYYY-MM-DD format in the account's time zone. The range can span at most 31 days, and Date To cannot be in the future. The defaults, {now-30} and {now}, cover the last 30 days.
  • See the Systeme API reference for the response fields.

Get Automation Email Statistics Summary

Retrieves total and per-day automation email statistics for a send-date range of up to 31 days.

  • Enter the Date From and Date To of the send-date range, in YYYY-MM-DD format in the account's time zone. The range can span at most 31 days, and Date To cannot be in the future. The defaults, {now-30} and {now}, cover the last 30 days.
  • See the Systeme API reference for the response fields.

List Specific-Address Automation Emails

Lists automation emails that are sent to a fixed recipient address. Results are paged automatically.

Get Specific-Address Automation Email

Retrieves one automation email that is sent to a fixed recipient address.

  • Enter the ID. Use the List Specific-Address Automation Emails template to find it.
  • See the Systeme API reference for the response fields.

Automation and workflows​

List Automation Rules

Lists automation rules with their triggers, actions, and active state. Results are paged automatically.

Get Automation Rule

Retrieves one automation rule with its triggers and actions.

  • Enter the ID. Use the List Automation Rules template to find it.
  • See the Systeme API reference for the response fields.

List Workflow Steps

Lists the steps of one workflow in execution order. Systeme marks this API as beta. Returns at most the first 100 steps.

  • Enter the Workflow ID of the workflow whose steps to list.
  • See the Systeme API reference for the response fields.

Courses​

Retrieve course collection

Lists courses. Results are paged automatically.

Get Course

Retrieves one course by ID.

  • Enter the ID. Use the Retrieve course collection template to find it.
  • See the Systeme API reference for the response fields.

List Course Curriculum

Lists the modules of one course together with their lectures. Returns at most the first 100 rows.

  • Enter the Course ID. Use the Retrieve course collection template to find it.
  • See the Systeme API reference for the response fields.

List Course Modules

Lists course modules across all courses. Results are paged automatically.

Get Course Module

Retrieves one course module by ID.

  • Enter the Module ID. Use the List Course Modules template to find it.
  • See the Systeme API reference for the response fields.

Get Lecture

Retrieves one course lecture by ID.

  • Enter the Lecture ID. Use the List Course Curriculum template to find it.
  • See the Systeme API reference for the response fields.

List Course Themes

Lists course themes. Results are paged automatically.

Retrieve enrollment collection

Lists course enrollments (which contact is enrolled in which course). Results are paged automatically.

Communities​

List Communities

Lists communities. Results are paged automatically.

Get Community

Retrieves one community by ID.

  • Enter the ID. Use the List Communities template to find it.
  • See the Systeme API reference for the response fields.

List Community Memberships

Lists community memberships (which contact belongs to which community). Results are paged automatically.

List Community Topics

Lists the topics of one community. Results are paged automatically.

  • Enter the Community ID. Use the List Communities template to find it.
  • See the Systeme API reference for the response fields.

Get Community Topic

Retrieves one community topic by ID.

  • Enter the Topic ID. Use the List Community Topics template to find it.
  • See the Systeme API reference for the response fields.

List Community Posts

Lists the posts of one community, in every status. Results are paged automatically.

  • Enter the Community ID. Use the List Communities template to find it.
  • See the Systeme API reference for the response fields.

Get Community Post

Retrieves one community post, including its content and attachments.

  • Enter the Post ID. Use the List Community Posts template to find it.
  • See the Systeme API reference for the response fields.

Products, offers, and payments​

List Digital Products

Lists digital products. Results are paged automatically.

Get Digital Product

Retrieves one digital product with its resources and price plans.

  • Enter the ID. Use the List Digital Products template to find it.
  • See the Systeme API reference for the response fields.

List Physical Products

Lists physical products. Results are paged automatically.

Get Physical Product

Retrieves one physical product with its images, options, and variants.

  • Enter the ID. Use the List Physical Products template to find it.
  • See the Systeme API reference for the response fields.

List Price Plans

Lists price plans. Results are paged automatically.

Get Price Plan

Retrieves one price plan by ID.

  • Enter the ID. Use the List Price Plans template to find it.
  • See the Systeme API reference for the response fields.

Get Offer

Retrieves one offer with its order bumps and coupons.

List Coupons

Lists coupons. Results are paged automatically.

Get Coupon

Retrieves one coupon by ID.

  • Enter the ID. Use the List Coupons template to find it.
  • See the Systeme API reference for the response fields.

Booking calendar​

List Booking Events

Lists booking calendar events, which are the bookable meeting types. Results are paged automatically.

Get Booking Event

Retrieves one booking calendar event with its locations and hosts.

  • Enter the Event ID. Use the List Booking Events template to find it.
  • See the Systeme API reference for the response fields.

List Bookings

Lists the bookings made through the booking calendar. Results are paged automatically.

Get User Availability

Retrieves the booking calendar availability settings: weekly hours, date overrides, and unavailability.

SMS​

List SMS Templates

Lists SMS templates. Results are paged automatically.

Get SMS Template

Retrieves one SMS template by ID.

  • Enter the Template ID. Use the List SMS Templates template to find it.
  • See the Systeme API reference for the response fields.

Get Twilio Account

Retrieves the Twilio account connected to Systeme for SMS.

List SMS Message Services

Lists the Twilio messaging services of the connected Twilio account.

List SMS Phone Numbers

Returns the phone numbers (in E.164 format) of the connected Twilio account that can send SMS, as one record.

Webhooks and account​

List Webhooks

Lists the webhooks configured in the account. Results are read in a single request.

Get Webhook

Retrieves one webhook with its event subscriptions.

  • Enter the ID. Use the List Webhooks template to find it.
  • See the Systeme API reference for the response fields.

List Workspace Members

Lists the members of the Systeme workspace.

List Domains

Lists the domains connected to the account. Results are paged automatically.

List Files

Lists the files in the account's file manager. Results are paged automatically.

Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.

Manual configuration​

Systeme data sources can also be manually configured to ingest data from any valid Systeme API endpoint, including endpoints not covered by the pre-built templates, chained API calls, or custom request parameters such as the optional filters on the contacts list. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers. Systeme endpoint URLs take the form https://api.systeme.io/api/..., and collection responses hold their records in $.items[*]; see the Systeme API reference for the available endpoints.

Once all of the relevant settings have been configured, click the Create button in the upper right corner of the screen to save and create the new Systeme data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.

Use as a destination​

Click the + icon on the Nexset that will be sent to the Systeme destination, and select the Send to Destination option from the menu. Select the Systeme connector from the list of available destination connectors, then select the credential that will be used to connect to your Systeme account, and click Next; or, create a new Systeme credential for use in this flow.

Endpoint templates​

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Systeme endpoints. Select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

Each record in the Nexset is sent as the JSON body of one request, one record at a time. ID settings, such as a contact, course, or newsletter ID, are fixed on the destination and apply to every record it sends, so each record acts on the same object. Update templates send the record as a JSON merge patch (application/merge-patch+json): only the fields present in the record change. Templates marked Side effect delete data, send email, or change access in ways that cannot be undone from Nexla.

Contacts, tags, and fields​

Create a contact

Creates a contact from each record. A record carries the contact's email and, optionally, fields (field values by slug) and locale.

  • No additional parameters are required.

Update a contact

Updates a contact with each record, as a JSON merge patch: only the fields in the record change.

  • Enter the Id. Use the Retrieve contact collection source template to find it.
  • See the Systeme API reference for details.

Remove a contact

Deletes a contact.

  • Side effect: the contact is permanently removed from Systeme.
  • Enter the Id. Use the Retrieve contact collection source template to find it.
  • Because the contact ID is fixed on the destination, send one record per destination.

Assign a tag to a contact

Adds a tag to a contact. Each record must include tagId.

  • Enter the Id. Use the Retrieve contact collection source template to find it.

Remove a tag from a contact

Removes a tag from a contact. The contact and the tag are not deleted.

  • Enter the Id. Use the Retrieve contact collection source template to find it.
  • Enter the Tag ID. Use the Retrieve tag collection source template to find it.
  • See the Systeme API reference for details.

Create a new tag

Creates a tag from each record. Each record must include name.

  • No additional parameters are required.

Replace a tag

Replaces a tag with each record, for example to rename it with {"name": "VIP"}.

  • Enter the Id. Use the Retrieve tag collection source template to find it.

Remove a tag

Deletes a tag.

  • Side effect: the tag is permanently deleted and removed from every contact.
  • Enter the Id. Use the Retrieve tag collection source template to find it.

Create a contact field

Creates a contact field from each record, with its fieldName and slug.

Update a contact field

Updates a contact field with each record, as a JSON merge patch.

  • Enter the Slug. Use the Retrieve contact field collection source template to find it.
  • See the Systeme API reference for details.

Remove a contact field

Deletes a contact field.

  • Side effect: the field and the values stored in it are permanently removed.
  • Enter the Slug. Use the Retrieve contact field collection source template to find it.
  • See the Systeme API reference for details.

Funnels and pages​

Create a funnel

Creates a funnel from each record.

  • No additional parameters are required.

Create a funnel step

Creates a step in a funnel from each record.

  • Enter the Id. Use the Retrieve funnel collection source template to find it.

Move Funnel Step

Moves a funnel step to the position given in each record. Systeme marks this API as beta.

  • Enter the ID. Use the List All Funnel Steps source template to find it.
  • See the Systeme API reference for details.

Update Sale Settings

Updates a funnel's sale settings with each record, as a JSON merge patch.

Save Page Content

Replaces the editor content of a page with each record.

  • Side effect: the page's current content is overwritten.
  • Enter the ID of the page.
  • See the Systeme API reference for details.

Replace Page Content From Template

Replaces a page's content from a template given in each record. Systeme marks this API as beta.

  • Side effect: the page's current content is overwritten.
  • Enter the Page ID of the page.
  • See the Systeme API reference for details.

Email marketing​

Create a newsletter

Creates a newsletter (broadcast email) from each record. Each record must include content.

  • No additional parameters are required.

Replace a newsletter

Replaces a newsletter with each record.

  • Enter the Id. Use the Retrieve newsletter collection source template to find it.

Update Newsletter

Updates a newsletter with each record, as a JSON merge patch.

  • Enter the ID. Use the Retrieve newsletter collection source template to find it.
  • See the Systeme API reference for details.

Delete Newsletter

Deletes a newsletter.

  • Side effect: the newsletter is permanently deleted.
  • Enter the ID. Use the Retrieve newsletter collection source template to find it.
  • See the Systeme API reference for details.

Replace Newsletter Included Tags

Replaces the tags a newsletter is sent to with the tags in each record.

  • Enter the ID. Use the Retrieve newsletter collection source template to find it.
  • See the Systeme API reference for details.

Replace Newsletter Excluded Tags

Replaces the tags excluded from a newsletter's audience with the tags in each record.

  • Enter the ID. Use the Retrieve newsletter collection source template to find it.
  • See the Systeme API reference for details.

Replace Newsletter Schedule

Sets when a newsletter is sent, from each record.

  • Side effect: the newsletter is emailed to its audience at the scheduled time.
  • Enter the ID. Use the Retrieve newsletter collection source template to find it.
  • See the Systeme API reference for details.

Send Newsletter

Sends a newsletter to its audience immediately.

  • Side effect: irreversible; emails go to real contacts.
  • Enter the ID. Use the Retrieve newsletter collection source template to find it.
  • Each record sent to this destination makes one send request for the same newsletter, so send a single record.
  • See the Systeme API reference for details.

Send Newsletter Test

Sends a test email of a newsletter to the testRecipientEmail given in each record.

  • Enter the ID. Use the Retrieve newsletter collection source template to find it.
  • See the Systeme API reference for details.

Create Campaign

Creates an email campaign (sequence) from each record.

Update Campaign

Updates an email campaign with each record, as a JSON merge patch.

  • Enter the ID. Use the List Campaigns source template to find it.
  • See the Systeme API reference for details.

Delete Campaign

Deletes an email campaign.

  • Side effect: the campaign and its steps are permanently deleted.
  • Enter the ID. Use the List Campaigns source template to find it.
  • See the Systeme API reference for details.

Create Campaign Step

Creates a step (email) in a campaign from each record.

  • Enter the Campaign ID. Use the List Campaigns source template to find it.
  • See the Systeme API reference for details.

Update Campaign Step

Updates a campaign step with each record, as a JSON merge patch.

  • Enter the ID. Use the List Campaign Steps source template to find it.
  • See the Systeme API reference for details.

Delete Campaign Step

Deletes a campaign step.

  • Side effect: the step is permanently deleted.
  • Enter the ID. Use the List Campaign Steps source template to find it.
  • See the Systeme API reference for details.

Send Campaign Step Test

Sends a test email of a campaign step to the recipient given in each record.

  • Enter the ID. Use the List Campaign Steps source template to find it.
  • See the Systeme API reference for details.

Create Automation Email

Creates an automation email from each record.

Update Automation Email

Updates an automation email with each record, as a JSON merge patch.

  • Enter the ID. Use the List Automation Emails source template to find it.
  • See the Systeme API reference for details.

Create Specific-Address Automation Email

Creates an automation email that is sent to a fixed recipient address, from each record.

Update Specific-Address Automation Email

Updates an automation email that is sent to a fixed recipient address, as a JSON merge patch.

  • Enter the ID. Use the List Specific-Address Automation Emails source template to find it.
  • See the Systeme API reference for details.

Automation and workflows​

Create Automation Rule

Creates an automation rule, with its triggers and actions, from each record.

  • Side effect: an active rule runs its actions on contacts when its trigger fires.
  • See the Systeme API reference for details.

Update Automation Rule

Updates an automation rule with each record, as a JSON merge patch.

  • Enter the ID. Use the List Automation Rules source template to find it.
  • See the Systeme API reference for details.

Delete Automation Rule

Deletes an automation rule.

  • Side effect: the rule is permanently deleted.
  • Enter the ID. Use the List Automation Rules source template to find it.
  • See the Systeme API reference for details.

Create Workflow Step

Creates a step in a workflow from each record. Systeme marks this API as beta.

Replace Workflow Step

Replaces a workflow step's configuration with each record. Systeme marks this API as beta.

  • Enter the ID. Use the List Workflow Steps source template to find it.
  • See the Systeme API reference for details.

Delete Workflow Step

Deletes a workflow step. Systeme marks this API as beta.

  • Side effect: the step is permanently deleted.
  • Enter the ID. Use the List Workflow Steps source template to find it.
  • See the Systeme API reference for details.

Courses​

Create Course

Creates a classic course from each record.

Update Course

Updates a course with each record, as a JSON merge patch.

  • Enter the ID. Use the Retrieve course collection source template to find it.
  • See the Systeme API reference for details.

Activate Course

Activates a course.

  • Enter the ID. Use the Retrieve course collection source template to find it.
  • See the Systeme API reference for details.

Deactivate Course

Deactivates a course.

  • Enter the ID. Use the Retrieve course collection source template to find it.
  • See the Systeme API reference for details.

Delete Course

Deletes a course.

  • Side effect: the course is permanently deleted.
  • Enter the ID. Use the Retrieve course collection source template to find it.
  • See the Systeme API reference for details.

Create Course Module

Creates a module in a course from each record.

  • Enter the Course ID. Use the Retrieve course collection source template to find it.
  • See the Systeme API reference for details.

Update Course Module

Updates a course module with each record, as a JSON merge patch.

  • Enter the Module ID. Use the List Course Modules source template to find it.
  • See the Systeme API reference for details.

Delete Course Module

Deletes a course module.

  • Side effect: the module is permanently deleted.
  • Enter the Module ID. Use the List Course Modules source template to find it.
  • See the Systeme API reference for details.

Create Lecture

Creates a classic lecture in a course module from each record.

  • Enter the Module ID. Use the List Course Modules source template to find it.
  • See the Systeme API reference for details.

Update Lecture

Updates a course lecture with each record, as a JSON merge patch.

  • Enter the Lecture ID. Use the List Course Curriculum source template to find it.
  • See the Systeme API reference for details.

Activate Lecture

Activates a course lecture.

  • Enter the Lecture ID. Use the List Course Curriculum source template to find it.
  • See the Systeme API reference for details.

Deactivate Lecture

Deactivates a course lecture.

  • Enter the Lecture ID. Use the List Course Curriculum source template to find it.
  • See the Systeme API reference for details.

Delete Lecture

Deletes a course lecture.

  • Side effect: the lecture is permanently deleted.
  • Enter the Lecture ID. Use the List Course Curriculum source template to find it.
  • See the Systeme API reference for details.

Create an enrollment for a course

Enrolls a contact in a course. Each record must include contactId and accessType.

  • Side effect: the contact gets access to the course.
  • Enter the Id. Use the Retrieve course collection source template to find it.

Remove an enrollment

Removes a course enrollment.

  • Side effect: the contact loses access to the course.
  • Enter the Id. Use the Retrieve enrollment collection source template to find it.

Communities​

Create Community

Creates a community from each record.

Update Community

Updates a community with each record, as a JSON merge patch.

  • Enter the ID. Use the List Communities source template to find it.
  • See the Systeme API reference for details.

Delete Community

Deletes a community.

  • Side effect: the community is permanently deleted.
  • Enter the ID. Use the List Communities source template to find it.
  • See the Systeme API reference for details.

Create Community Membership

Adds a contact to a community, one membership per record.

  • Enter the Community ID. Use the List Communities source template to find it.
  • See the Systeme API reference for details.

Delete Community Membership

Removes a community membership.

  • Side effect: the contact loses access to the community.
  • Enter the ID. Use the List Community Memberships source template to find it.
  • See the Systeme API reference for details.

Create Community Topic

Creates a topic in a community from each record.

  • Enter the Community ID. Use the List Communities source template to find it.
  • See the Systeme API reference for details.

Update Community Topic

Updates a community topic with each record, as a JSON merge patch.

  • Enter the Topic ID. Use the List Community Topics source template to find it.
  • See the Systeme API reference for details.

Delete Community Topic

Deletes a community topic.

  • Side effect: the topic is permanently deleted.
  • Enter the Topic ID. Use the List Community Topics source template to find it.
  • See the Systeme API reference for details.

Products, offers, and payments​

Create Digital Product

Creates a digital product from each record.

Update Digital Product

Updates a digital product with each record, as a JSON merge patch.

  • Enter the ID. Use the List Digital Products source template to find it.
  • See the Systeme API reference for details.

Delete Digital Product

Deletes a digital product.

  • Side effect: the product is permanently deleted.
  • Enter the ID. Use the List Digital Products source template to find it.
  • See the Systeme API reference for details.

Create Physical Product

Creates a physical product from each record.

Update Physical Product

Updates a physical product with each record, as a JSON merge patch.

  • Enter the ID. Use the List Physical Products source template to find it.
  • See the Systeme API reference for details.

Delete Physical Product

Deletes a physical product.

  • Side effect: the product is permanently deleted.
  • Enter the ID. Use the List Physical Products source template to find it.
  • See the Systeme API reference for details.

Create Price Plan

Creates a price plan from each record.

Update Price Plan

Updates a price plan with each record, as a JSON merge patch.

  • Enter the ID. Use the List Price Plans source template to find it.
  • See the Systeme API reference for details.

Delete Price Plan

Deletes a price plan.

  • Side effect: the price plan is permanently deleted.
  • Enter the ID. Use the List Price Plans source template to find it.
  • See the Systeme API reference for details.

Create Offer

Creates an offer from each record.

Update Offer

Updates an offer with each record, as a JSON merge patch.

Create Coupon

Creates a coupon from each record.

Update Coupon

Updates a coupon with each record, as a JSON merge patch.

Delete Coupon

Deletes a coupon.

  • Side effect: the coupon is permanently deleted and can no longer be redeemed.
  • Enter the ID. Use the List Coupons source template to find it.
  • See the Systeme API reference for details.

Cancel Subscription

Cancels a contact's payment subscription.

  • Side effect: the contact is unsubscribed and future payments stop.
  • Enter the ID. Use the List Contact Subscriptions source template to find it.
  • See the Systeme API reference for details.

Booking calendar​

Create Booking Event

Creates a booking calendar event (a bookable meeting type) from each record.

Update Booking Event

Updates a booking calendar event with each record, as a JSON merge patch.

  • Enter the Event ID. Use the List Booking Events source template to find it.
  • See the Systeme API reference for details.

Delete Booking Event

Deletes a booking calendar event.

  • Side effect: the event is permanently deleted.
  • Enter the Event ID. Use the List Booking Events source template to find it.
  • See the Systeme API reference for details.

Create User Availability

Creates the booking calendar availability settings from a record.

Update User Availability

Updates the booking calendar availability settings with a record, as a JSON merge patch.

SMS​

Create SMS Template

Creates an SMS template from each record.

Update SMS Template

Updates an SMS template with each record, as a JSON merge patch.

  • Enter the Template ID. Use the List SMS Templates source template to find it.
  • See the Systeme API reference for details.

Delete SMS Template

Deletes an SMS template.

  • Side effect: the template is permanently deleted.
  • Enter the Template ID. Use the List SMS Templates source template to find it.
  • See the Systeme API reference for details.

Webhooks​

Create Webhook

Creates a webhook from each record. Each record must include name, secret, url, and subscriptions (the events to send).

Update Webhook

Updates a webhook with each record, as a JSON merge patch.

  • Enter the ID. Use the List Webhooks source template to find it.
  • See the Systeme API reference for details.

Delete Webhook

Deletes a webhook.

  • Side effect: Systeme stops sending events to that URL.
  • Enter the ID. Use the List Webhooks source template to find it.
  • See the Systeme API reference for details.

Manual configuration​

Systeme destinations can also be manually configured to send data to any valid Systeme API endpoint. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, data format, endpoint URL, request headers, attribute exclusions, record batching, and response webhooks.

The Systeme API expects JSON request bodies; its PATCH operations accept only application/merge-patch+json. For update, replace, and delete operations, put the ID or slug of the object at the end of the endpoint URL.

Save & activate​

Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To send the data to the configured Systeme endpoint, open the destination resource menu, and select Activate.

The Nexset data will not be sent to the Systeme endpoint until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.