Sendy

App · 8 actions

Manage Sendy subscribers and create draft, scheduled or sending campaigns.

Actions

ActionWhat it does
Create campaignCreate a draft campaign, or send or schedule it when Send campaign is 1.
Delete subscriberDelete subscriber.
Get subscriber countGet subscriber count.
Get subscription statusGet subscription status.
List brandsList brands.
List listsList lists.
SubscribeSubscribe.
UnsubscribeUnsubscribe.

Create campaign

Create a draft campaign, or send or schedule it when Send campaign is 1. Sending requires Sendy’s sending cron job.

Inputs

Brandbrand_idtextRequired
The brand that owns the list.
From namefrom_nametextRequired
From name.
From emailfrom_emailtextRequired
From email.
Reply toreply_totextRequired
Reply to.
TitletitletextRequired
Title.
SubjectsubjecttextRequired
Subject.
HTML texthtml_texttextRequired
Html text.
Plain textplain_texttext
Plain text.
Send campaignsend_campaignnumber
Send campaign.One of: 0 (Save draft), 1 (Send or schedule).
List IDSlist_idslist
List ids.
Segment IDSsegment_idslist
Segment ids.
Track openstrack_opensnumber
Track opens.One of: 0 (Disabled), 1 (Enabled), 2 (Anonymous).
Track clickstrack_clicksnumber
Track clicks.One of: 0 (Disabled), 1 (Enabled), 2 (Anonymous).
Schedule date timeschedule_date_timedate and time
Scheduled sending time, rounded to a five-minute boundary. Sent in UTC.
Query stringquery_stringtext
Query string.

Outputs

dataobject
Complete response from the service, including its pagination and job status fields.
has_moretrue/false
Whether the service reports another page.
next_cursortext
Cursor for the next page, when supplied by the service.
Example output
{
  "data": {
    "status": ""
  },
  "has_more": false,
  "next_cursor": ""
}

Delete subscriber

Delete subscriber.

Inputs

Brandbrand_idtextRequired
The brand that owns the list.
Listlist_idtextRequired
Choose a list after choosing a brand, or use its encrypted ID.
EmailemailtextRequired
Email.

Outputs

dataobject
Complete response from the service, including its pagination and job status fields.
has_moretrue/false
Whether the service reports another page.
next_cursortext
Cursor for the next page, when supplied by the service.
Example output
{
  "data": {
    "success": false
  },
  "has_more": false,
  "next_cursor": ""
}

Get subscriber count

Get subscriber count.

Inputs

Brandbrand_idtextRequired
The brand that owns the list.
Listlist_idtextRequired
Choose a list after choosing a brand, or use its encrypted ID.

Outputs

dataobject
Complete response from the service, including its pagination and job status fields.
has_moretrue/false
Whether the service reports another page.
next_cursortext
Cursor for the next page, when supplied by the service.
Example output
{
  "data": {
    "count": 0
  },
  "has_more": false,
  "next_cursor": ""
}

Get subscription status

Get subscription status.

Inputs

Brandbrand_idtextRequired
The brand that owns the list.
Listlist_idtextRequired
Choose a list after choosing a brand, or use its encrypted ID.
EmailemailtextRequired
Email.

Outputs

dataobject
Complete response from the service, including its pagination and job status fields.
has_moretrue/false
Whether the service reports another page.
next_cursortext
Cursor for the next page, when supplied by the service.
Example output
{
  "data": {
    "status": ""
  },
  "has_more": false,
  "next_cursor": ""
}

List brands

List brands.

Inputs

None.

Outputs

datalist
Complete response from the service, including its pagination and job status fields.
has_moretrue/false
Whether the service reports another page.
next_cursortext
Cursor for the next page, when supplied by the service.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": ""
}

List lists

List lists.

Inputs

Brandbrand_idtextRequired
The brand that owns the list.
Include hiddeninclude_hiddentext
Include hidden.One of: yes, no.

Outputs

datalist
Complete response from the service, including its pagination and job status fields.
has_moretrue/false
Whether the service reports another page.
next_cursortext
Cursor for the next page, when supplied by the service.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": ""
}

Subscribe

Subscribe.

Inputs

Brandbrand_idtextRequired
The brand that owns the list.
Listlist_idtextRequired
Choose a list after choosing a brand, or use its encrypted ID.
EmailemailtextRequired
Email.
Namenametext
Name.
Countrycountrytext
Country.
Ipaddressipaddresstext
Ipaddress.
Referrerreferrertext
Referrer.
Gdprgdprtrue/false
Gdpr.
Silentsilenttrue/false
Silent.
Custom fieldscustom_fieldsobject
Custom-field personalization tags and their values.

Outputs

dataobject
Complete response from the service, including its pagination and job status fields.
has_moretrue/false
Whether the service reports another page.
next_cursortext
Cursor for the next page, when supplied by the service.
Example output
{
  "data": {
    "success": false
  },
  "has_more": false,
  "next_cursor": ""
}

Unsubscribe

Unsubscribe.

Inputs

Brandbrand_idtextRequired
The brand that owns the list.
Listlist_idtextRequired
Choose a list after choosing a brand, or use its encrypted ID.
EmailemailtextRequired
Email.

Outputs

dataobject
Complete response from the service, including its pagination and job status fields.
has_moretrue/false
Whether the service reports another page.
next_cursortext
Cursor for the next page, when supplied by the service.
Example output
{
  "data": {
    "success": false
  },
  "has_more": false,
  "next_cursor": ""
}

On this page