Systeme.io

App · 30 actions

Work with your Systeme.io marketing account: create, find, update and tag contacts, manage tags and custom contact fields, enroll contacts in courses, create discount coupons, and manage webhooks.

Actions

ActionWhat it does
Add tag to contactGive a contact a tag, which can start automations that watch for it.
Create contactAdd a contact with an email address, and optionally a language, custom fields and tags.
Create contact fieldAdd a custom field that contacts can hold a value in.
Create couponCreate a discount code customers can enter at checkout.
Create tagCreate a tag to label contacts with.
Create webhookHave Systeme.io post the events you choose to an https address.
Delete contactDelete a contact.
Delete contact fieldDelete a custom contact field and the values contacts hold in it.
Delete couponDelete a coupon so its code stops working.
Delete tagDelete a tag, which takes it off every contact that has it.
Delete webhookDelete a webhook so Systeme.io stops sending to it.
Enroll contact in courseGive a contact access to a course, in full or released over time.
Get contactGet one contact with its language, custom fields and tags.
Get couponGet one coupon with its code, discount and limits.
Get courseGet one course with its address, language and modules.
Get tagGet one tag.
Get webhookGet one webhook with its address, state and subscriptions.
List contact fieldsList the fields a contact can hold, built in and custom, with their slugs.
List contactsList contacts, filtered by email, tags, state or when they registered.
List couponsList discount coupons, or those matching a search text.
List coursesList the account's courses, filtered by name or whether they are active.
List enrollmentsList course enrollments, for one course or one contact.
List tagsList the account's tags, or those matching a search text.
List webhooksList the account's webhooks with their addresses and the events each is subscribed to.
Remove enrollmentTake a contact's access to a course away.
Remove tag from contactTake a tag off a contact.
Rename contact fieldChange the name a custom contact field is shown with.
Rename tagGive a tag a new name.
Update contactChange a contact's language or custom fields.
Update couponRename a coupon, or change when it expires or how many times it can be used.

Add tag to contact

Give a contact a tag, which can start automations that watch for it.

Inputs

Contact IDcontact_idtextRequired
The contact's id, from 'List contacts', 'Create contact' or an earlier step.
Tagtag_idtextRequired
The tag. Pick one, or give its id from an earlier step.

Outputs

addedtrue/false
Always true once added
contact_idnumber
The contact tagged
tag_idnumber
The tag added
Example output
{
  "added": true,
  "contact_id": 4521,
  "tag_id": 301
}

Create contact

Add a contact with an email address, and optionally a language, custom fields and tags. The email address cannot be changed afterwards.

Inputs

EmailemailtextRequired
The contact's email address.
Languagelocaletext
The contact's language, used for the emails Systeme.io sends them.One of: en (English), fr (French), es (Spanish), it (Italian), pt (Portuguese), de (German), nl (Dutch), ru (Russian), jp (Japanese), tr (Turkish), and 18 more.
Fieldsfieldsobject
Contact fields to fill in, each with the field's slug and the value, for example {"first_name": "Jo", "surname": "Bloggs"}. See 'List contact fields' for the slugs.
Tagstagslist
Tags to give the contact.

Outputs

contactobject
The contact
Example output
{
  "contact": {
    "bounced": false,
    "email": "jo@example.com",
    "fields": [
      {
        "fieldName": "First name",
        "slug": "first_name",
        "value": "Jo"
      }
    ],
    "id": 4521,
    "locale": "en",
    "needsConfirmation": false,
    "registeredAt": "2026-10-15T09:00:00+00:00",
    "sourceURL": "https://example.systeme.io/optin",
    "tags": [
      {
        "id": 301,
        "name": "Newsletter"
      }
    ],
    "unsubscribed": false
  }
}

Create contact field

Add a custom field that contacts can hold a value in.

Inputs

Field namefield_nametextRequired
The name shown in Systeme.io, such as Company size.
SlugslugtextRequired
The field's key, used when filling it in. Lowercase letters, digits and underscores, starting with a letter.

Outputs

fieldobject
The contact field
Example output
{
  "field": {
    "fieldName": "Company size",
    "slug": "company_size"
  }
}

Create coupon

Create a discount code customers can enter at checkout.

Inputs

Nameinner_nametextRequired
A name only you see, to tell the coupon apart.
CodecodetextRequired
What customers type at checkout. No spaces.
Discount typediscount_typetextRequired
A percentage off, or a fixed amount off.One of: percent (Percentage off), fixed (Fixed amount off).
Discountdiscount_amountnumberRequired
The percentage (1 to 100) or the amount off, in the currency chosen below.At least 0.
CurrencycurrencytextRequired
The currency the coupon applies to.One of: aud, cad, dkk, eur, hkd, ils, jpy, mxn, nzd, nok, and 48 more.
Expiresexpiration_datedate and time
When the coupon stops working. Leave empty for no change (no expiry for a new coupon).
Uses allowedlimit_of_usenumber
How many times the coupon can be used in total. Leave empty for no change (unlimited for a new coupon).At least 1.

Outputs

couponobject
The coupon
Example output
{
  "coupon": {
    "active": true,
    "code": "LAUNCH10",
    "currency": "usd",
    "discountAmount": 10,
    "discountType": "percent",
    "expirationDate": "2026-12-31T23:59:00+00:00",
    "id": 55,
    "innerName": "Launch offer",
    "limitOfUse": 100
  }
}

Create tag

Create a tag to label contacts with.

Inputs

NamenametextRequired
The tag's name, at most 64 characters.

Outputs

tagobject
The tag
Example output
{
  "tag": {
    "createdAt": "2026-10-15T09:00:00+00:00",
    "id": 301,
    "name": "Newsletter"
  }
}

Create webhook

Have Systeme.io post the events you choose to an https address. The result includes the secret each delivery is signed with, which Systeme.io never shows again.

Inputs

NamenametextRequired
A name to tell the webhook apart in Systeme.io.
AddressurltextRequired
The https:// address to send events to.
EventseventslistRequired
Which events to send.One or more of: CONTACT_CREATED (A contact is created), CONTACT_OPT_IN (A contact opts in), CONTACT_TAG_ADDED (A tag is added to a contact), CONTACT_TAG_REMOVED (A tag is removed from a contact), SALE_NEW (A new sale is made), SALE_CANCELED (A sale is canceled).
Signing secretsecrettext
The secret to sign each delivery with. Leave empty to have one made for you.

Outputs

secrettext
The secret deliveries are signed with
webhookobject
The webhook
Example output
{
  "secret": "3f9a1c0be27d45d6",
  "webhook": {
    "active": true,
    "id": "wh_01HXAMPLE",
    "name": "Send to CRM",
    "subscriptions": [
      {
        "disabledAt": "",
        "disabledReason": "",
        "event": "CONTACT_CREATED",
        "id": "sub_01HX",
        "schemaVersion": 1
      }
    ],
    "url": "https://example.com/systeme"
  }
}

Delete contact

Delete a contact. Systeme.io may keep its data for several days, and a contact added again with the same email can inherit it.

Inputs

Contact IDcontact_idtextRequired
The contact's id, from 'List contacts', 'Create contact' or an earlier step.

Outputs

contact_idnumber
The contact deleted
deletedtrue/false
Always true once deleted
Example output
{
  "contact_id": 4521,
  "deleted": true
}

Delete contact field

Delete a custom contact field and the values contacts hold in it.

Inputs

Contact fieldslugtextRequired
The contact field. Pick one, or give its slug (such as company_size).

Outputs

deletedtrue/false
Always true once deleted
slugtext
The field deleted
Example output
{
  "deleted": true,
  "slug": "company_size"
}

Delete coupon

Delete a coupon so its code stops working.

Inputs

Couponcoupon_idtextRequired
The coupon. Pick one, or give its id from an earlier step.

Outputs

coupon_idnumber
The coupon deleted
deletedtrue/false
Always true once deleted
Example output
{
  "coupon_id": 55,
  "deleted": true
}

Delete tag

Delete a tag, which takes it off every contact that has it.

Inputs

Tagtag_idtextRequired
The tag. Pick one, or give its id from an earlier step.

Outputs

deletedtrue/false
Always true once deleted
tag_idnumber
The tag deleted
Example output
{
  "deleted": true,
  "tag_id": 301
}

Delete webhook

Delete a webhook so Systeme.io stops sending to it.

Inputs

Webhookwebhook_idtextRequired
The webhook. Pick one, or give its id from an earlier step.

Outputs

deletedtrue/false
Always true once deleted
webhook_idtext
The webhook deleted
Example output
{
  "deleted": true,
  "webhook_id": "wh_01HXAMPLE"
}

Enroll contact in course

Give a contact access to a course, in full or released over time.

Inputs

Coursecourse_idtextRequired
The course. Pick one, or give its id from an earlier step.
Contact IDcontact_idtextRequired
The contact's id, from 'List contacts', 'Create contact' or an earlier step.
Accessaccess_typetext
Full access to every lesson, or lessons released over time. Defaults to full access.One of: full_access (Full access (default)), dripping_content (Content released over time).

Outputs

enrollmentobject
The enrollment
Example output
{
  "enrollment": {
    "accessType": "full_access",
    "active": true,
    "contact": {
      "email": "jo@example.com",
      "id": 4521
    },
    "course": {
      "active": true,
      "id": 77,
      "name": "Intro course",
      "path": "intro"
    },
    "id": 880
  }
}

Get contact

Get one contact with its language, custom fields and tags.

Inputs

Contact IDcontact_idtextRequired
The contact's id, from 'List contacts', 'Create contact' or an earlier step.

Outputs

contactobject
The contact
Example output
{
  "contact": {
    "bounced": false,
    "email": "jo@example.com",
    "fields": [
      {
        "fieldName": "First name",
        "slug": "first_name",
        "value": "Jo"
      }
    ],
    "id": 4521,
    "locale": "en",
    "needsConfirmation": false,
    "registeredAt": "2026-10-15T09:00:00+00:00",
    "sourceURL": "https://example.systeme.io/optin",
    "tags": [
      {
        "id": 301,
        "name": "Newsletter"
      }
    ],
    "unsubscribed": false
  }
}

Get coupon

Get one coupon with its code, discount and limits.

Inputs

Couponcoupon_idtextRequired
The coupon. Pick one, or give its id from an earlier step.

Outputs

couponobject
The coupon
Example output
{
  "coupon": {
    "active": true,
    "code": "LAUNCH10",
    "currency": "usd",
    "discountAmount": 10,
    "discountType": "percent",
    "expirationDate": "2026-12-31T23:59:00+00:00",
    "id": 55,
    "innerName": "Launch offer",
    "limitOfUse": 100
  }
}

Get course

Get one course with its address, language and modules.

Inputs

Coursecourse_idtextRequired
The course. Pick one, or give its id from an earlier step.

Outputs

courseobject
The course
Example output
{
  "course": {
    "active": true,
    "description": "A first course.",
    "domainName": "learn.example.com",
    "id": 77,
    "locale": "en",
    "modules": [
      {
        "id": 9,
        "name": "Welcome"
      }
    ],
    "name": "Intro course",
    "path": "intro"
  }
}

Get tag

Get one tag.

Inputs

Tagtag_idtextRequired
The tag. Pick one, or give its id from an earlier step.

Outputs

tagobject
The tag
Example output
{
  "tag": {
    "createdAt": "2026-10-15T09:00:00+00:00",
    "id": 301,
    "name": "Newsletter"
  }
}

Get webhook

Get one webhook with its address, state and subscriptions.

Inputs

Webhookwebhook_idtextRequired
The webhook. Pick one, or give its id from an earlier step.

Outputs

webhookobject
The webhook
Example output
{
  "webhook": {
    "active": true,
    "id": "wh_01HXAMPLE",
    "name": "Send to CRM",
    "subscriptions": [
      {
        "disabledAt": "",
        "disabledReason": "",
        "event": "CONTACT_CREATED",
        "id": "sub_01HX",
        "schemaVersion": 1
      }
    ],
    "url": "https://example.com/systeme"
  }
}

List contact fields

List the fields a contact can hold, built in and custom, with their slugs.

Inputs

None.

Outputs

countnumber
How many on this page
fieldslist
The contact fields
has_moretrue/false
True if there are more after this page
next_cursortext
Pass as 'starting after' to get the next page; empty on the last one
Example output
{
  "count": 1,
  "fields": [
    {
      "fieldName": "Company size",
      "slug": "company_size"
    }
  ],
  "has_more": false,
  "next_cursor": ""
}

List contacts

List contacts, filtered by email, tags, state or when they registered. Gets one page; to see more, run it again with the next page it gives.

Inputs

Emailemailtext
Only the contact with exactly this email address.
Tagstagslist
Only contacts that have all of these tags.
Registered afterregistered_afterdate and time
Only contacts who registered after this date and time.
Registered beforeregistered_beforedate and time
Only contacts who registered before this date and time.
Unsubscribedunsubscribedtext
Only contacts who have, or have not, unsubscribed.One of: any (Either), yes, no.
Bouncedbouncedtext
Only contacts whose emails have, or have not, bounced.One of: any (Either), yes, no.
Awaiting confirmationneeds_confirmationtext
Only contacts who still have, or no longer have, to confirm their email.One of: any (Either), yes, no.
Page sizelimitnumber
How many to return, 10 to 100.From 10 to 100.
Starting afterstarting_aftertext
The 'next_cursor' from an earlier page, to get the page after it.
Orderordertext
Newest first or oldest first. Keep it the same from page to page.One of: desc (Newest first (default)), asc (Oldest first).

Outputs

contactslist
The contacts
countnumber
How many on this page
has_moretrue/false
True if there are more after this page
next_cursortext
Pass as 'starting after' to get the next page; empty on the last one
Example output
{
  "contacts": [
    {
      "bounced": false,
      "email": "jo@example.com",
      "fields": [
        {
          "fieldName": "First name",
          "slug": "first_name",
          "value": "Jo"
        }
      ],
      "id": 4521,
      "locale": "en",
      "needsConfirmation": false,
      "registeredAt": "2026-10-15T09:00:00+00:00",
      "sourceURL": "https://example.systeme.io/optin",
      "tags": [
        {
          "id": 301,
          "name": "Newsletter"
        }
      ],
      "unsubscribed": false
    }
  ],
  "count": 1,
  "has_more": false,
  "next_cursor": ""
}

List coupons

List discount coupons, or those matching a search text. Gets one page; to see more, run it again with the next page it gives.

Inputs

Searchquerytext
Only coupons whose name or code matches this text.
Page sizelimitnumber
How many to return, 10 to 100.From 10 to 100.
Starting afterstarting_aftertext
The 'next_cursor' from an earlier page, to get the page after it.
Orderordertext
Newest first or oldest first. Keep it the same from page to page.One of: desc (Newest first (default)), asc (Oldest first).

Outputs

countnumber
How many on this page
couponslist
The coupons
has_moretrue/false
True if there are more after this page
next_cursortext
Pass as 'starting after' to get the next page; empty on the last one
Example output
{
  "count": 1,
  "coupons": [
    {
      "active": true,
      "code": "LAUNCH10",
      "currency": "usd",
      "discountAmount": 10,
      "discountType": "percent",
      "expirationDate": "2026-12-31T23:59:00+00:00",
      "id": 55,
      "innerName": "Launch offer",
      "limitOfUse": 100
    }
  ],
  "has_more": false,
  "next_cursor": ""
}

List courses

List the account's courses, filtered by name or whether they are active. Gets one page; to see more, run it again with the next page it gives.

Inputs

Searchquerytext
Only courses, modules or lectures whose name matches this text.
Activeactivetext
Only courses that are, or are not, active.One of: any (Either), yes, no.
Page sizelimitnumber
How many to return, 10 to 100.From 10 to 100.
Starting afterstarting_aftertext
The 'next_cursor' from an earlier page, to get the page after it.
Orderordertext
Newest first or oldest first. Keep it the same from page to page.One of: desc (Newest first (default)), asc (Oldest first).

Outputs

countnumber
How many on this page
courseslist
The courses
has_moretrue/false
True if there are more after this page
next_cursortext
Pass as 'starting after' to get the next page; empty on the last one
Example output
{
  "count": 1,
  "courses": [
    {
      "active": true,
      "description": "A first course.",
      "domainName": "learn.example.com",
      "id": 77,
      "locale": "en",
      "modules": [
        {
          "id": 9,
          "name": "Welcome"
        }
      ],
      "name": "Intro course",
      "path": "intro"
    }
  ],
  "has_more": false,
  "next_cursor": ""
}

List enrollments

List course enrollments, for one course or one contact. Gets one page; to see more, run it again with the next page it gives.

Inputs

Coursecourse_idtext
Only enrollments in this course.
Contact IDcontact_idtext
Only enrollments of this contact, by id.
Page sizelimitnumber
How many to return, 10 to 100.From 10 to 100.
Starting afterstarting_aftertext
The 'next_cursor' from an earlier page, to get the page after it.
Orderordertext
Newest first or oldest first. Keep it the same from page to page.One of: desc (Newest first (default)), asc (Oldest first).

Outputs

countnumber
How many on this page
enrollmentslist
The enrollments
has_moretrue/false
True if there are more after this page
next_cursortext
Pass as 'starting after' to get the next page; empty on the last one
Example output
{
  "count": 1,
  "enrollments": [
    {
      "accessType": "full_access",
      "active": true,
      "contact": {
        "email": "jo@example.com",
        "id": 4521
      },
      "course": {
        "active": true,
        "id": 77,
        "name": "Intro course",
        "path": "intro"
      },
      "id": 880
    }
  ],
  "has_more": false,
  "next_cursor": ""
}

List tags

List the account's tags, or those matching a search text. Gets one page; to see more, run it again with the next page it gives.

Inputs

Searchquerytext
Only tags whose name matches this text.
Page sizelimitnumber
How many to return, 10 to 100.From 10 to 100.
Starting afterstarting_aftertext
The 'next_cursor' from an earlier page, to get the page after it.
Orderordertext
Newest first or oldest first. Keep it the same from page to page.One of: desc (Newest first (default)), asc (Oldest first).

Outputs

countnumber
How many on this page
has_moretrue/false
True if there are more after this page
next_cursortext
Pass as 'starting after' to get the next page; empty on the last one
tagslist
The tags
Example output
{
  "count": 1,
  "has_more": false,
  "next_cursor": "",
  "tags": [
    {
      "createdAt": "2026-10-15T09:00:00+00:00",
      "id": 301,
      "name": "Newsletter"
    }
  ]
}

List webhooks

List the account's webhooks with their addresses and the events each is subscribed to.

Inputs

None.

Outputs

countnumber
How many on this page
has_moretrue/false
True if there are more after this page
next_cursortext
Pass as 'starting after' to get the next page; empty on the last one
webhookslist
The webhooks
Example output
{
  "count": 1,
  "has_more": false,
  "next_cursor": "",
  "webhooks": [
    {
      "active": true,
      "id": "wh_01HXAMPLE",
      "name": "Send to CRM",
      "subscriptions": [
        {
          "disabledAt": "",
          "disabledReason": "",
          "event": "CONTACT_CREATED",
          "id": "sub_01HX",
          "schemaVersion": 1
        }
      ],
      "url": "https://example.com/systeme"
    }
  ]
}

Remove enrollment

Take a contact's access to a course away.

Inputs

Enrollment IDenrollment_idtextRequired
The enrollment's id, from 'List enrollments' or 'Enroll contact in course'.

Outputs

deletedtrue/false
Always true once removed
enrollment_idnumber
The enrollment removed
Example output
{
  "deleted": true,
  "enrollment_id": 880
}

Remove tag from contact

Take a tag off a contact.

Inputs

Contact IDcontact_idtextRequired
The contact's id, from 'List contacts', 'Create contact' or an earlier step.
Tagtag_idtextRequired
The tag. Pick one, or give its id from an earlier step.

Outputs

contact_idnumber
The contact untagged
removedtrue/false
Always true once removed
tag_idnumber
The tag removed
Example output
{
  "contact_id": 4521,
  "removed": true,
  "tag_id": 301
}

Rename contact field

Change the name a custom contact field is shown with. Its slug stays the same.

Inputs

Contact fieldslugtextRequired
The contact field. Pick one, or give its slug (such as company_size).
New namefield_nametextRequired
The name to show in Systeme.io.

Outputs

fieldobject
The contact field
Example output
{
  "field": {
    "fieldName": "Company size",
    "slug": "company_size"
  }
}

Rename tag

Give a tag a new name. Contacts keep the tag.

Inputs

Tagtag_idtextRequired
The tag. Pick one, or give its id from an earlier step.
New namenametextRequired
The tag's new name, at most 64 characters.

Outputs

tagobject
The tag
Example output
{
  "tag": {
    "createdAt": "2026-10-15T09:00:00+00:00",
    "id": 301,
    "name": "Newsletter"
  }
}

Update contact

Change a contact's language or custom fields. Anything left empty stays as it is.

Inputs

Contact IDcontact_idtextRequired
The contact's id, from 'List contacts', 'Create contact' or an earlier step.
Languagelocaletext
The contact's language, used for the emails Systeme.io sends them.One of: en (English), fr (French), es (Spanish), it (Italian), pt (Portuguese), de (German), nl (Dutch), ru (Russian), jp (Japanese), tr (Turkish), and 18 more.
Fieldsfieldsobject
Contact fields to change, each with the field's slug and the new value, for example {"first_name": "Jo"}. A field given an empty value is cleared; fields not listed are left as they are.

Outputs

contactobject
The contact
Example output
{
  "contact": {
    "bounced": false,
    "email": "jo@example.com",
    "fields": [
      {
        "fieldName": "First name",
        "slug": "first_name",
        "value": "Jo"
      }
    ],
    "id": 4521,
    "locale": "en",
    "needsConfirmation": false,
    "registeredAt": "2026-10-15T09:00:00+00:00",
    "sourceURL": "https://example.systeme.io/optin",
    "tags": [
      {
        "id": 301,
        "name": "Newsletter"
      }
    ],
    "unsubscribed": false
  }
}

Update coupon

Rename a coupon, or change when it expires or how many times it can be used. The code and discount cannot change.

Inputs

Couponcoupon_idtextRequired
The coupon. Pick one, or give its id from an earlier step.
Nameinner_nametext
A new name for the coupon. Leave empty to keep it.
Expiresexpiration_datedate and time
When the coupon stops working. Leave empty for no change (no expiry for a new coupon).
Uses allowedlimit_of_usenumber
How many times the coupon can be used in total. Leave empty for no change (unlimited for a new coupon).At least 1.

Outputs

couponobject
The coupon
Example output
{
  "coupon": {
    "active": true,
    "code": "LAUNCH10",
    "currency": "usd",
    "discountAmount": 10,
    "discountType": "percent",
    "expirationDate": "2026-12-31T23:59:00+00:00",
    "id": 55,
    "innerName": "Launch offer",
    "limitOfUse": 100
  }
}

On this page