Flodesk
App · 23 actions
Manage subscribers, segments, workflows, campaigns, custom fields, and webhook subscriptions in Flodesk.
Actions
| Action | What it does |
|---|---|
| Add subscriber to segments | Add the subscriber to segments. |
| Add subscriber to workflow | Add a subscriber to workflow. |
| Batch create or update subscribers | Batch create or update subscribers. |
| Create custom field | Create a custom field. |
| Create or update subscriber | Create or update a subscriber. |
| Create segment | Create a segment. |
| Create webhook | Create a webhook. |
| Delete webhook | Delete a webhook. |
| Get segment | Retrieve a segment. |
| Get subscriber | Retrieve a subscriber. |
| Get webhook | Retrieve a webhook. |
| List all custom fields | List all custom fields. |
| List campaigns | List campaigns. |
| List colors | List all segment colors. |
| List custom fields | List all custom fields (pagination). |
| List segments | List all segments. |
| List subscribers | List all subscribers. |
| List webhooks | List all webhooks. |
| List workflows | List workflows. |
| Remove subscriber from segments | Remove the subscriber from segments. |
| Remove subscriber from workflow | Remove a subscriber from workflow. |
| Unsubscribe subscriber | Unsubscribe from all lists. |
| Update webhook | Update a webhook. |
Add subscriber to segments
Add the subscriber to segments.
Inputs
- Id or email
id_or_emailtextRequired - Id or email.
- Segment ids
segment_idslistRequired - An array of identifiers of the segments.
Outputs
dataobject- Flodesk response data.
Example output
{
"data": {
"created_at": "example",
"custom_fields": {},
"email": "example",
"first_name": "example",
"id": "example",
"last_name": "example",
"optin_ip": "example",
"optin_timestamp": "example",
"segments": [],
"source": "manual",
"status": "active"
}
}Add subscriber to workflow
Add a subscriber to workflow.
Inputs
- Workflow
record_workflow_idtextRequired - Workflow id.
- Id
idtext - `id` is required if `email` is not present
- Email
emailtext - `email` is required if `id` is not present
Outputs
dataobject- Flodesk response data.
Example output
{
"data": {}
}Batch create or update subscribers
Batch create or update subscribers.
Inputs
- Subscribers
subscriberslistRequired - List of subscribers to create or update. Maximum 50 items.
Outputs
dataobject- Flodesk response data.
Example output
{
"data": {
"failures": [],
"successes": []
}
}Create custom field
Create a custom field.
Inputs
- Label
labeltextRequired - A friendly display label of the custom field.
Outputs
dataobject- Flodesk response data.
Example output
{
"data": {
"key": "example",
"label": "example"
}
}Create or update subscriber
Create or update a subscriber.
Inputs
- Id
idtext - The subscriber's `id`. Either `email` or `id` must be included.
- Email
emailtext - The subscriber's `email`. Either `email` or `id` must be included.
- First name
first_nametext - The subscriber's first name.
- Last name
last_nametext - The subscriber's last name.
- Custom fields
custom_fieldsobject - An object containing custom field data. E.g. ``` "favorite_color": "Lavender" ```.
- Segment ids
segment_idslist - The segments this subscriber will be added to. Cap at `50`.
- Double optin
double_optintrue/false - Whether or not to require the subscriber to confirm subscription via email. This option is only available to set with new subscriber creation. Default to `false` if not indicated.
- Optin ip
optin_iptext - IP address from which the subscriber confirmed their opt-in.
- Optin timestamp
optin_timestampdate and time - The date and time the subscribers confirmed their opt-in in ISO 8601 format. E.g. `2023-01-02T15:04:05.999Z`.
Outputs
dataobject- Flodesk response data.
Example output
{
"data": {
"created_at": "example",
"custom_fields": {},
"email": "example",
"first_name": "example",
"id": "example",
"last_name": "example",
"optin_ip": "example",
"optin_timestamp": "example",
"segments": [],
"source": "manual",
"status": "active"
}
}Create segment
Create a segment.
Inputs
- Name
nametext - Name.
- Color
colortext - The color of the segment using a hex code. `Use GET List all segment colors`. to view available colors.
Outputs
dataobject- Flodesk response data.
Example output
{
"data": {
"color": "example",
"created_at": "example",
"id": "example",
"name": "example",
"segment_type": "example",
"total_active_subscribers": 1
}
}Create webhook
Create a webhook.
Inputs
- Name
nametextRequired - The webhook name.
- Post url
post_urltextRequired - The url that the webhook will post to.
- Events
eventslistRequired - An array specifying which events are enabled for webhook notifications.
Outputs
dataobject- Flodesk response data.
Example output
{
"data": {
"created_at": "example",
"events": [],
"id": "example",
"post_url": "example"
}
}Delete webhook
Delete a webhook.
Inputs
- Id
idtextRequired - Id.
Outputs
dataobject- Flodesk response data.
Example output
{
"data": {}
}Get segment
Retrieve a segment.
Inputs
- Id
idtextRequired - Id.
Outputs
dataobject- Flodesk response data.
Example output
{
"data": {
"color": "example",
"created_at": "example",
"id": "example",
"name": "example",
"segment_type": "example",
"total_active_subscribers": 1
}
}Get subscriber
Retrieve a subscriber.
Inputs
- Id or email
id_or_emailtextRequired - Id or email.
Outputs
dataobject- Flodesk response data.
Example output
{
"data": {
"created_at": "example",
"custom_fields": {},
"email": "example",
"first_name": "example",
"id": "example",
"last_name": "example",
"optin_ip": "example",
"optin_timestamp": "example",
"segments": [],
"source": "manual",
"status": "active"
}
}Get webhook
Retrieve a webhook.
Inputs
- Id
idtextRequired - Id.
Outputs
dataobject- Flodesk response data.
Example output
{
"data": {
"created_at": "example",
"events": [],
"id": "example",
"post_url": "example"
}
}List all custom fields
List all custom fields.
Inputs
None.
Outputs
datalist- Flodesk response data.
Example output
{
"data": []
}List campaigns
List campaigns.
Inputs
- Page
pagenumber - The page number. Defaults to 1.
- Per page
per_pagenumber - The number of records to be returned on each page. Defaults to 20. Maximum 100.
- Search
searchtext - Search.
- Order by
order_bytext - Order by.
- Sort
sorttext - Sort.
- Status
statustext - Status.One of:
draft,pending,scheduled,composing,sending,done,failed. - Shared as template
shared_as_templatetrue/false - Shared as template.
Outputs
dataobject- Flodesk response data.
Example output
{
"data": {
"data": []
}
}List colors
List all segment colors.
Inputs
None.
Outputs
datalist- Flodesk response data.
Example output
{
"data": []
}List custom fields
List all custom fields (pagination).
Inputs
- Page
pagenumber - The page number. Defaults to 1.
- Per page
per_pagenumber - The number of records to be returned on each page. Defaults to 20. Maximum 100.
Outputs
dataobject- Flodesk response data.
Example output
{
"data": {
"data": [],
"meta": {
"page": 1,
"per_page": 1,
"total_items": 1,
"total_pages": 1
}
}
}List segments
List all segments.
Inputs
- Page
pagenumber - The page number. Defaults to 1.
- Per page
per_pagenumber - The number of records to be returned on each page. Defaults to 20. Maximum 100.
Outputs
dataobject- Flodesk response data.
Example output
{
"data": {
"data": [],
"meta": {
"page": 1,
"per_page": 1,
"total_items": 1,
"total_pages": 1
}
}
}List subscribers
List all subscribers.
Inputs
- Page
pagenumber - The page number. Defaults to 1.
- Per page
per_pagenumber - The number of records to be returned on each page. Defaults to 20. Maximum 100.
- Status
statustext - Optional. The subscriber's status. `active`: The subscriber is currently active to receive marketing emails. `unsubscribed`: The subscriber has opted out of marketing emails. `unconfirmed`: The subscriber is pending for double opt-in confirmation. `bounced`: The subscriber's address is undeliverable due to a.One of:
active,unsubscribed,unconfirmed,bounced,complained,cleaned,archived. - Segment id
segment_idtext - Optional. The segment's id. When included, returns only subscribers who were added to the given segment.
Outputs
dataobject- Flodesk response data.
Example output
{
"data": {
"data": [],
"meta": {
"page": 1,
"per_page": 1,
"total_items": 1,
"total_pages": 1
}
}
}List webhooks
List all webhooks.
Inputs
- Page
pagenumber - The page number. Defaults to 1.
- Per page
per_pagenumber - The number of records to be returned on each page. Defaults to 20. Maximum 100.
Outputs
dataobject- Flodesk response data.
Example output
{
"data": {
"data": [],
"meta": {
"page": 1,
"per_page": 1,
"total_items": 1,
"total_pages": 1
}
}
}List workflows
List workflows.
Inputs
- Statuses
statuseslist - filter by workflow statuses e.g. statuses=active,paused. Default is all statusesOne or more of:
active,paused,draft. - Page
pagenumber - Default = 1
- Per page
per_pagenumber - Default = 10
Outputs
dataobject- Flodesk response data.
Example output
{
"data": {
"data": [],
"meta": {
"page": 1,
"per_page": 1,
"total_items": 1,
"total_pages": 1
}
}
}Remove subscriber from segments
Remove the subscriber from segments.
Inputs
- Id or email
id_or_emailtextRequired - Id or email.
- Segment ids
segment_idslistRequired - An array of identifiers of the segments.
Outputs
dataobject- Flodesk response data.
Example output
{
"data": {
"created_at": "example",
"custom_fields": {},
"email": "example",
"first_name": "example",
"id": "example",
"last_name": "example",
"optin_ip": "example",
"optin_timestamp": "example",
"segments": [],
"source": "manual",
"status": "active"
}
}Remove subscriber from workflow
Remove a subscriber from workflow.
Inputs
- Workflow
record_workflow_idtextRequired - Workflow id.
- Id or email
id_or_emailtextRequired - Id or email.
Outputs
dataobject- Flodesk response data.
Example output
{
"data": {}
}Unsubscribe subscriber
Unsubscribe from all lists.
Inputs
- Id or email
id_or_emailtextRequired - Id or email.
Outputs
dataobject- Flodesk response data.
Example output
{
"data": {
"created_at": "example",
"custom_fields": {},
"email": "example",
"first_name": "example",
"id": "example",
"last_name": "example",
"optin_ip": "example",
"optin_timestamp": "example",
"segments": [],
"source": "manual",
"status": "active"
}
}Update webhook
Update a webhook.
Inputs
- Id
idtextRequired - Id.
- Name
nametext - The webhook name.
- Post url
post_urltext - The url that the webhook will post to.
- Events
eventslist - An array specifying which events are enabled for webhook notifications.
Outputs
dataobject- Flodesk response data.
Example output
{
"data": {
"created_at": "example",
"events": [],
"id": "example",
"post_url": "example"
}
}