Flodesk

App · 23 actions

Manage subscribers, segments, workflows, campaigns, custom fields, and webhook subscriptions in Flodesk.

Actions

ActionWhat it does
Add subscriber to segmentsAdd the subscriber to segments.
Add subscriber to workflowAdd a subscriber to workflow.
Batch create or update subscribersBatch create or update subscribers.
Create custom fieldCreate a custom field.
Create or update subscriberCreate or update a subscriber.
Create segmentCreate a segment.
Create webhookCreate a webhook.
Delete webhookDelete a webhook.
Get segmentRetrieve a segment.
Get subscriberRetrieve a subscriber.
Get webhookRetrieve a webhook.
List all custom fieldsList all custom fields.
List campaignsList campaigns.
List colorsList all segment colors.
List custom fieldsList all custom fields (pagination).
List segmentsList all segments.
List subscribersList all subscribers.
List webhooksList all webhooks.
List workflowsList workflows.
Remove subscriber from segmentsRemove the subscriber from segments.
Remove subscriber from workflowRemove a subscriber from workflow.
Unsubscribe subscriberUnsubscribe from all lists.
Update webhookUpdate a webhook.

Add subscriber to segments

Add the subscriber to segments.

Inputs

Id or emailid_or_emailtextRequired
Id or email.
Segment idssegment_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

Workflowrecord_workflow_idtextRequired
Workflow id.
Ididtext
`id` is required if `email` is not present
Emailemailtext
`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

SubscriberssubscriberslistRequired
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

LabellabeltextRequired
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

Ididtext
The subscriber's `id`. Either `email` or `id` must be included.
Emailemailtext
The subscriber's `email`. Either `email` or `id` must be included.
First namefirst_nametext
The subscriber's first name.
Last namelast_nametext
The subscriber's last name.
Custom fieldscustom_fieldsobject
An object containing custom field data. E.g. ``` "favorite_color": "Lavender" ```.
Segment idssegment_idslist
The segments this subscriber will be added to. Cap at `50`.
Double optindouble_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 ipoptin_iptext
IP address from which the subscriber confirmed their opt-in.
Optin timestampoptin_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

Namenametext
Name.
Colorcolortext
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

NamenametextRequired
The webhook name.
Post urlpost_urltextRequired
The url that the webhook will post to.
EventseventslistRequired
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

IdidtextRequired
Id.

Outputs

dataobject
Flodesk response data.
Example output
{
  "data": {}
}

Get segment

Retrieve a segment.

Inputs

IdidtextRequired
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 emailid_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

IdidtextRequired
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

Pagepagenumber
The page number. Defaults to 1.
Per pageper_pagenumber
The number of records to be returned on each page. Defaults to 20. Maximum 100.
Searchsearchtext
Search.
Order byorder_bytext
Order by.
Sortsorttext
Sort.
Statusstatustext
Status.One of: draft, pending, scheduled, composing, sending, done, failed.
Shared as templateshared_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

Pagepagenumber
The page number. Defaults to 1.
Per pageper_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

Pagepagenumber
The page number. Defaults to 1.
Per pageper_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

Pagepagenumber
The page number. Defaults to 1.
Per pageper_pagenumber
The number of records to be returned on each page. Defaults to 20. Maximum 100.
Statusstatustext
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 idsegment_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

Pagepagenumber
The page number. Defaults to 1.
Per pageper_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

Statusesstatuseslist
filter by workflow statuses e.g. statuses=active,paused. Default is all statusesOne or more of: active, paused, draft.
Pagepagenumber
Default = 1
Per pageper_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 emailid_or_emailtextRequired
Id or email.
Segment idssegment_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

Workflowrecord_workflow_idtextRequired
Workflow id.
Id or emailid_or_emailtextRequired
Id or email.

Outputs

dataobject
Flodesk response data.
Example output
{
  "data": {}
}

Unsubscribe subscriber

Unsubscribe from all lists.

Inputs

Id or emailid_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

IdidtextRequired
Id.
Namenametext
The webhook name.
Post urlpost_urltext
The url that the webhook will post to.
Eventseventslist
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"
  }
}

On this page