Sailthru Connection

Based on resource template Base.

[Read] action

Endpoint URL address: /ad/plan.
The result is extracted from: {{=Sailthru.getCorrectResultArray(response,'ad_plans')}}.

The action has the following user-defined parameters:

• name: Plan Name.

Documentation: https://getstarted.sailthru.com/developers/api/ad-plan/.

---

[Create] action

Endpoint URL address: /ad/plan.

Documentation: https://getstarted.sailthru.com/developers/api/ad-plan/#POST_Mode.

---

[Delete] action

Endpoint URL address: /ad/plan.

Documentation: https://getstarted.sailthru.com/developers/api/ad-plan/#DELETE_Mode.

---

The resource includes the fields from the AdTargeterPlan template.

Based on resource template Base.

[Read] action

Endpoint URL address: /blast.
The result is extracted from: {{=Sailthru.getCorrectResultArray(response,'blasts')}}.

The action has the following user-defined parameters:

• blast_id: Returns blast with the specified blast ID.You must pass either blast_id or status, but not both.
• status: Returns blasts with the specified status.You must pass either blast_id or status, but not both.
• vars: Pass 1 to return vars that have been set on this blast.
• limit:

Documentation: https://getstarted.sailthru.com/developers/api/blast/#GET_Blast_Data.

---

[Create] action

Endpoint URL address: /blast.

Documentation: https://getstarted.sailthru.com/developers/api/blast/#POST_Mode.

---

[Update] action

Endpoint URL address: /blast.

Documentation: https://getstarted.sailthru.com/developers/api/blast/#POST_Mode.

---

[Delete] action

Endpoint URL address: /blast.

Documentation: https://getstarted.sailthru.com/developers/api/blast/#DELETE_Blast.

---

The resource includes the fields from the Blast template.

Based on resource template Base.

[Read] action

Endpoint URL address: /blast_repeat.
The result is extracted from: {{=Sailthru.getCorrectResultArray(response,'repeats')}}.

The action has the following user-defined parameters:

• repeat_id: Recurring campaign ID.

Documentation: https://getstarted.sailthru.com/developers/api/blast_repeat/#GET_Mode.

---

[Create] action

Endpoint URL address: /blast_repeat.

Documentation: https://getstarted.sailthru.com/developers/api/blast_repeat/#POST_to_Create_or_Update_Recurring_Campaign.

---

[Update] action

Endpoint URL address: /blast_repeat.

Documentation: https://getstarted.sailthru.com/developers/api/blast_repeat/#POST_to_Create_or_Update_Recurring_Campaign.

---

[Delete] action

Endpoint URL address: /blast_repeat.

Documentation: https://getstarted.sailthru.com/developers/api/blast_repeat/#DELETE_Mode.

---

The resource includes the fields from the BlastRepeat template.

Based on resource template Base.

[Read] action

Endpoint URL address: /content.
The result is extracted from: {{=Sailthru.getCorrectResultArray(response,'content')}}.

The action has the following user-defined parameters:

• id: An identifier for the item (by default, the item’s URL).
• key: url or sku, to specify which identifier is being referenced in the id field. If unspecified, the default is url.
• url: For backward compatibility with an earlier version of the content API, you can reference an item by its URL using the url parameter. It is recommended that you instead use the id parameter to specify the URL.
• items: If you have not specified a specific item id or url, this is the number of items to return, in order of recency. When not provided, the default is 20.

Documentation: https://getstarted.sailthru.com/developers/api/content/#GET_Mode.

---

[Create] action

Endpoint URL address: /content.

Documentation: https://getstarted.sailthru.com/developers/api/content/#POST_Mode.

---

[Update] action

Endpoint URL address: /content.

Documentation: https://getstarted.sailthru.com/developers/api/content/#POST_Mode.

---

[Delete] action

Endpoint URL address: /content.

The action has the following user-defined parameters:

• id: An identifier for the item (by default, the item’s URL).
• key: url or sku, to specify which identifier is being referenced in the id field. If unspecified, the default is url.
• url: For backward compatibility with an earlier version of the content API, you can reference an item by its URL using the url parameter. It is recommended that you instead use the id parameter to specify the URL.

Documentation: https://getstarted.sailthru.com/developers/api/blast_repeat/#DELETE_Mode.

---

The resource includes the fields from the Content template.

Based on resource template Base.

[Create] action

Endpoint URL address: /event.

Documentation: https://getstarted.sailthru.com/developers/api/event/.

---

The resource includes the fields from the Event template.

Based on resource template Base.

[Read] action

Endpoint URL address: /include.
The result is extracted from: {{=Sailthru.getCorrectResultArray(response,'includes')}}.

The action has the following user-defined parameters:

• include: If a name is provided, only returns that users with that unique indentifier.

Documentation: https://getstarted.sailthru.com/developers/api/include/#GET_Mode.

---

[Create] action

Endpoint URL address: /include.

Documentation: https://getstarted.sailthru.com/developers/api/include/#POST_Mode.

---

[Update] action

Endpoint URL address: /include.

Documentation: https://getstarted.sailthru.com/developers/api/include/#POST_Mode.

---

The resource includes the fields from the Include template.

Based on resource template Base.

[Read] action

Endpoint URL address: /trigger.
The result is extracted from: {{=Sailthru.getCorrectResultArray(response,'triggers')}}.

The action has the following user-defined parameters:

• template: Name of the template.
• trigger_id: Trigger ID.
• event: Event Name.

Documentation: https://getstarted.sailthru.com/developers/api/trigger/#GET_Mode.

---

[Create] action

Endpoint URL address: /trigger.

Documentation: https://getstarted.sailthru.com/developers/api/trigger/#POST_Mode.

---

[Delete] action

Endpoint URL address: /trigger.

Documentation: https://getstarted.sailthru.com/developers/api/trigger/#DELETE_Mode.

---

The resource includes the fields from the Trigger template.

Based on resource template Base.

[Read] action

Endpoint URL address: /template.
The result is extracted from: {{=Sailthru.getCorrectResultArray(response,'templates')}}.

The action has the following user-defined parameters:

• template: The name of the template.
• revision: Revision ID for a given revision.
• sample: The sample name (for A/B test templates).

Documentation: https://getstarted.sailthru.com/developers/api/template/#GET_Mode.

---

[Create] action

Endpoint URL address: /template.

Documentation: https://getstarted.sailthru.com/developers/api/template/#POST_Mode.

---

[Update] action

Endpoint URL address: /template.

Documentation: https://getstarted.sailthru.com/developers/api/template/#POST_Mode.

---

[Delete] action

Endpoint URL address: /template.

Documentation: https://getstarted.sailthru.com/developers/api/template/#DELETE_Template.

---

The resource includes the fields from the Template template.

Based on resource template Base.

[Read] action

Endpoint URL address: /list.
The result is extracted from: {{=Sailthru.getCorrectResultArray(response,'lists')}}.

The action has the following user-defined parameters:

• list: The name of the list.
• list_id: The ID of the list.
• fields: The fields to return. Only needed to return variables.
• primary: Filter to show only lists marked as primary.

Documentation: https://getstarted.sailthru.com/developers/api/list/#GET_a_list.

---

[Create] action

Endpoint URL address: /list.

Documentation: https://getstarted.sailthru.com/developers/api/list/#POSTto_Create_or_Modify_List.

---

[Update] action

Endpoint URL address: /list.

Documentation: https://getstarted.sailthru.com/developers/api/list/#POSTto_Create_or_Modify_List.

---

[Delete] action

Endpoint URL address: /list.

Documentation: https://getstarted.sailthru.com/developers/api/list/#DELETEa_List.

---

The resource includes the fields from the List template.

Based on resource template Base.

[Read] action

Endpoint URL address: /user.
The result is extracted from: {{=[response]}}.

The action has the following user-defined parameters:

• id: Required. The ID of the user.
• key: The key type of user ID.The default key type is email.
• fields: In the fields object, include only those fields that you want returned.

Documentation: https://getstarted.sailthru.com/developers/api/user/#GET_user_profile_data.

---

[Create] action

Endpoint URL address: /user.

Documentation: https://getstarted.sailthru.com/developers/api/user/#POST_to_createor_update_user.

---

[Update] action

Endpoint URL address: /user.

Documentation: https://getstarted.sailthru.com/developers/api/user/#POST_to_createor_update_user.

---

[Delete] action

Endpoint URL address: /user.

Documentation: https://getstarted.sailthru.com/developers/api/user/#DELETE_a_user.

---

The resource includes the fields from the User template.

Based on resource template Base.

[Read] action

Endpoint URL address: /stats.
The result is extracted from: {{=[response]}}.

The action has the following user-defined parameters:

• stat: Required. The type of the stat. Default value is "list"
• list: The name of the list to pull information about. If this parameter is left empty, you will retrieve information about all of your subscribers.
• date: The date to pull information from. If this parameter is left empty, you will retrieve information from the most recent snapshot (today). Note that list subscriber count snapshots are calculated at midnight, so the data provided under a date could be considered to represent end-of-day data for the previous date. In the My.Sailthru reporting interface, the same data is labeled as representing that previous date.

Documentation: https://getstarted.sailthru.com/developers/api/stats/#list.

---

The resource includes the fields from the ListStat template.

Based on resource template Base.

[Read] action

Endpoint URL address: /stats.
The result is extracted from: {{=[response]}}.

The action has the following user-defined parameters:

• stat: Required. The type of the stat. Default value is "blast"
• blast_id: The id of the blast to pull information from. Required if start_dateand end_dateare not specified.
• start_date: The beginning of the date range from which to pull aggregated blast stats. Required if "blast_id" is not specified.
• end_date: The end of the date range from which to pull aggregated blast stats. Required if "blast_id" is not specified.

Documentation: https://getstarted.sailthru.com/developers/api/stats/#blast.

---

The resource includes the fields from the BlastStat template.

Based on resource template Base.

[Read] action

Endpoint URL address: /stats.
The result is extracted from: {{=[response]}}.

The action has the following user-defined parameters:

• stat: Required. The type of the stat. Default value is "send"
• template: Required. The name of the template to pull information from.
• start_date: Required. The beginning of the date range from which to pull aggregated send stats.
• end_date: Required. The end of the date range from which to pull aggregated send stats.

Documentation: https://getstarted.sailthru.com/developers/api/stats/#send.

---

The resource includes the fields from the SendStat template.

Based on resource template Base.

[Read] action

Endpoint URL address: /send.
The result is extracted from: {{=[response]}}.

The action has the following user-defined parameters:

• send_id: Required. The unique identifier of the send.

Documentation: https://getstarted.sailthru.com/developers/api/send/#GET_Triggered_Send.

---

[Create] action

Endpoint URL address: /send.

Documentation: https://getstarted.sailthru.com/developers/api/send/#POST_to_Send_Schedule_or_Update.

---

[Update] action

Endpoint URL address: /send.

Documentation: https://getstarted.sailthru.com/developers/api/send/#POST_to_Send_Schedule_or_Update.

---

[Delete] action

Endpoint URL address: /send.

Documentation: https://getstarted.sailthru.com/developers/api/send/#DELETEa_scheduled_send.

---

The resource includes the fields from the Send template.

Based on resource template Base.

[Read] action

Endpoint URL address: /settings.
The result is extracted from: {{=[response]}}.

Documentation: https://getstarted.sailthru.com/developers/api/settings/#GET.

---

[Update] action

Endpoint URL address: /settings.

Documentation: https://getstarted.sailthru.com/developers/api/settings/#POST.

---

The resource includes the fields from the Settings template.

Based on resource template Base.

[Create] action

Endpoint URL address: /return.

Documentation: https://getstarted.sailthru.com/developers/api/return/.

---

The resource includes the fields from the Return template.

Based on resource template Base.

[Read] action

Endpoint URL address: /purchase.
The result is extracted from: {{=[response]}}.

The action has the following user-defined parameters:

• purchase_id: Required. The unique id of the purchase. If a purchase_id is not passed, the system requires an extid. Note: Purchases older than one year cannot be viewed via the purchase API. To export this purchase data, use the Purchase Log to export all data for the desired date.
• purchase_key: Required. The key type for the purchase_id. There are two types: sid and extid. The default value is sid. However, a client can provide a custom extid. If an extid is not performed, the system defaults to sid. purchase_key must be used with the purchase_id parameter.

Documentation: https://getstarted.sailthru.com/developers/api/purchase/#GET_a_purchase.

---

[Create] action

Endpoint URL address: /purchase.

Documentation: https://getstarted.sailthru.com/developers/api/purchase/#POSTa_purchase.

---

The resource includes the fields from the Purchase template.

Based on resource template Base.

[Read] action

Endpoint URL address: /preview.
The result is extracted from: {{=[response]}}.

The action has the following user-defined parameters:

• template: The name of the template to preview.
• blast_id: The id of the blast to preview.
• blast_repeat_id: The id of the repeating blast to preview.
• content_html: A block of text to parse and preview
• email: The email address of the user for whom to generate dynamic content. This will return in content_html.
• send_email: The email address to receive the preview.

Documentation: https://getstarted.sailthru.com/developers/api/preview/#GETPOST_to_Generate_Preview.

---

The resource includes the fields from the Preview template.

[Read] action

Endpoint URL address: /job.
The result is extracted from: {{=[response]}}.

The action has the following user-defined parameters:

• job_id: Required. A job’s unique identification.

The following request parameters will be automatically processed:

• json: {{=JSON.stringify(parameters)}}

Documentation: https://getstarted.sailthru.com/developers/api/job/#GET_Mode.

---

[Create] action

Endpoint URL address: /job.
The action uses POST method.

The following request parameters will be automatically processed:

• file: {{=item.file}}
• application/json: {{=item}}

Documentation: https://getstarted.sailthru.com/developers/api/job/#POSTMode.

---

The resource includes the fields from the Job template.

[Read] action

The following request parameters will be automatically processed:

• json: {{=JSON.stringify(parameters)}}

---

[Create] action

The action uses POST method.

The following request parameters will be automatically processed:

• json: {{=JSON.stringify(item)}}

---

[Update] action

The action uses POST method.

The following request parameters will be automatically processed:

• json: {{=JSON.stringify(item)}}

---

[Delete] action

The action uses DELETE method.

The following request parameters will be automatically processed:

• json: {{=JSON.stringify(item)}}

---