Sendy
App · 8 actions
Manage Sendy subscribers and create draft, scheduled or sending campaigns.
Actions
| Action | What it does |
|---|---|
| Create campaign | Create a draft campaign, or send or schedule it when Send campaign is 1. |
| Delete subscriber | Delete subscriber. |
| Get subscriber count | Get subscriber count. |
| Get subscription status | Get subscription status. |
| List brands | List brands. |
| List lists | List lists. |
| Subscribe | Subscribe. |
| Unsubscribe | Unsubscribe. |
Create campaign
Create a draft campaign, or send or schedule it when Send campaign is 1. Sending requires Sendy’s sending cron job.
Inputs
- Brand
brand_idtextRequired - The brand that owns the list.
- From name
from_nametextRequired - From name.
- From email
from_emailtextRequired - From email.
- Reply to
reply_totextRequired - Reply to.
- Title
titletextRequired - Title.
- Subject
subjecttextRequired - Subject.
- HTML text
html_texttextRequired - Html text.
- Plain text
plain_texttext - Plain text.
- Send campaign
send_campaignnumber - Send campaign.One of:
0(Save draft),1(Send or schedule). - List IDS
list_idslist - List ids.
- Segment IDS
segment_idslist - Segment ids.
- Track opens
track_opensnumber - Track opens.One of:
0(Disabled),1(Enabled),2(Anonymous). - Track clicks
track_clicksnumber - Track clicks.One of:
0(Disabled),1(Enabled),2(Anonymous). - Schedule date time
schedule_date_timedate and time - Scheduled sending time, rounded to a five-minute boundary. Sent in UTC.
- Query string
query_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
- Brand
brand_idtextRequired - The brand that owns the list.
- List
list_idtextRequired - Choose a list after choosing a brand, or use its encrypted ID.
- Email
emailtextRequired - 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
- Brand
brand_idtextRequired - The brand that owns the list.
- List
list_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
- Brand
brand_idtextRequired - The brand that owns the list.
- List
list_idtextRequired - Choose a list after choosing a brand, or use its encrypted ID.
- Email
emailtextRequired - 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
- Brand
brand_idtextRequired - The brand that owns the list.
- Include hidden
include_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
- Brand
brand_idtextRequired - The brand that owns the list.
- List
list_idtextRequired - Choose a list after choosing a brand, or use its encrypted ID.
- Email
emailtextRequired - Email.
- Name
nametext - Name.
- Country
countrytext - Country.
- Ipaddress
ipaddresstext - Ipaddress.
- Referrer
referrertext - Referrer.
- Gdpr
gdprtrue/false - Gdpr.
- Silent
silenttrue/false - Silent.
- Custom fields
custom_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
- Brand
brand_idtextRequired - The brand that owns the list.
- List
list_idtextRequired - Choose a list after choosing a brand, or use its encrypted ID.
- Email
emailtextRequired - 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": ""
}