ConvertKit (Independent Publisher)
ConvertKit is the go-to marketing hub for creators that helps you grow and monetize your audience with ease. Convert your followers from social media, YouTube, and more to your email list with a beautiful landing page and opt-in templates.
This connector is available in the following products and regions:
Service | Class | Regions |
---|---|---|
Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
Power Automate | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
Power Apps | Premium | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
Contact | |
---|---|
Name | Troy Taylor |
URL | https://www.hitachisolutions.com |
ttaylor@hitachisolutions.com |
Connector Metadata | |
---|---|
Publisher | Troy Taylor, Hitachi Solutions |
Website | https://convertkit.com/ |
Privacy policy | https://convertkit.com/privacy |
Categories | Marketing |
The connector supports the following authentication types:
Default | Parameters for creating connection. | All regions | Not shareable |
Applicable: All regions
Parameters for creating connection.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
Name | Type | Description | Required |
---|---|---|---|
API Secret | securestring | The API Secret for this api | True |
Name | Calls | Renewal Period |
---|---|---|
API calls per connection | 100 | 60 seconds |
Add subscriber to a form |
Subscribe an email address to one of your forms. |
Add subscriber to a sequence |
Subscribe an email address to one of your sequences. |
Create a broadcast |
Create a draft or scheduled broadcast. You can create a draft broadcast without any attributes. Scheduled broadcasts at a minimum should contain a subject line and your content. |
Create a purchase |
Create a purchase. |
Create a tag |
Creates a new tag. |
Destroy a broadcast |
Permanently delete a draft or scheduled broadcast record. Broadcasts that are currently sending or that have been sent may not be deleted. |
Get a purchase |
Retrieve a specific purchase by ID. |
Get a subscriber |
Retrieves a single subscriber record. |
Get account |
Retrieves the current account. |
Get broadcast stats |
Retrieves the statistics (recipient count, open rate, click rate, unsubscribe count, total clicks, status, and send progress) for a specific broadcast. |
Get forms |
Retrieve a list of all the forms for your account. |
List broadcasts |
Retrieves a list of all the broadcasts for your account. |
List purchases |
Retrieve a list of all purchases for an account. |
List sequences |
Retrieves a list of sequences for the account. |
List subscriber's tags |
Retrieves a list of all the tags for a subscriber. |
List subscribers |
Returns a list of your subscribers. For unsubscribes only, use the cancelled at value for sort field param (currently the only supported extra sort field). |
List subscriptions to a form |
Retrieves a list of subscriptions to a form including subscriber data. |
List subscriptions to a sequence |
Retrieves subscriptions to a sequence including subscriber data. |
List subscriptions to a tag |
Retrieves a list of subscriptions to a tag including subscriber data. |
List tags |
Retrieves a list of tags for the account. |
Remove tag from subscriber |
Removes a tag from a subscriber. |
Remove tag from subscriber by email |
Remove a tag from a subscriber by email address. |
Retrieve a broadcast |
Retrieves the details of a specific broadcast, including draft, scheduled, and previously-sent broadcasts. |
Tag a subscriber |
Tags are handled as subscriptions. Subscribe an email address to a tag to have that tag applied to the subscriber with that email address. |
Unsubscribe subscriber |
Unsubscribe a subscriber from all your forms and sequences. |
Update a broadcast |
Updates the attributes of a specific broadcast. Broadcasts that are currently sending or that have been sent may not be updated. |
Update subscriber |
Updates the information for a single subscriber. |
Subscribe an email address to one of your forms.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Form ID
|
form_id | True | string |
The form unique identifier. |
Email
|
True | string |
The email address. |
|
First Name
|
first_name | string |
The first name. |
|
Tags
|
tags | array of integer |
Returns
Name | Path | Type | Description |
---|---|---|---|
ID
|
subscription.id | integer |
The unique identifier. |
State
|
subscription.state | string |
The state. |
Created At
|
subscription.created_at | string |
When created at. |
Source
|
subscription.source | string |
The source. |
Referrer
|
subscription.referrer | string |
The referrer. |
Subscribable ID
|
subscription.subscribable_id | integer |
The subscribable unique identifier. |
Subscribable Type
|
subscription.subscribable_type | string |
The subscribable type. |
ID
|
subscription.subscriber.id | integer |
The unique identifier. |
First Name
|
subscription.subscriber.first_name | string |
The first name. |
Email Address
|
subscription.subscriber.email_address | string |
The email address. |
State
|
subscription.subscriber.state | string |
The state. |
Created At
|
subscription.subscriber.created_at | string |
When created at. |
Subscribe an email address to one of your sequences.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Sequence ID
|
sequence_id | True | string |
The sequence unique identifier. |
Email
|
True | string |
The email address. |
|
First Name
|
first_name | string |
The first name. |
|
Tags
|
tags | array of integer |
Returns
Name | Path | Type | Description |
---|---|---|---|
ID
|
subscription.id | integer |
The unique identifier. |
State
|
subscription.state | string |
The state. |
Created At
|
subscription.created_at | string |
When created at. |
Source
|
subscription.source | string |
The source. |
Referrer
|
subscription.referrer | string |
The referrer. |
Subscribable ID
|
subscription.subscribable_id | integer |
The subscribable unique identifier. |
Subscribable Type
|
subscription.subscribable_type | string |
The subscribable type. |
ID
|
subscription.subscriber.id | integer |
The unique identifier. |
Create a draft or scheduled broadcast. You can create a draft broadcast without any attributes. Scheduled broadcasts at a minimum should contain a subject line and your content.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Description
|
description | string |
The description. |
|
Subject
|
subject | string |
The subject. |
|
Content
|
content | string |
The content. |
|
Email Address
|
email_address | string |
The email address. |
|
Email Layout Template
|
email_layout_template | string |
The email layout template. |
|
Public
|
public | boolean |
Whether public. |
|
Published At
|
published_at | string |
When published at. |
|
Send At
|
send_at | string |
When send at. |
|
Thumbnail Alt
|
thumbnail_alt | string |
The alt-text for the thumbnail. |
|
Thumbnail URL
|
thumbnail_url | string |
The URL address for the thumbnail. |
Returns
Name | Path | Type | Description |
---|---|---|---|
ID
|
broadcast.id | integer |
The unique identifier. |
Created At
|
broadcast.created_at | string |
When created at. |
Subject
|
broadcast.subject | string |
The subject. |
Description
|
broadcast.description | string |
The description. |
Content
|
broadcast.content | string |
The content. |
Public
|
broadcast.public | boolean |
Whether public. |
Published At
|
broadcast.published_at | string |
When published at. |
Send At
|
broadcast.send_at | string |
When sent at. |
Thumbnail Alt
|
broadcast.thumbnail_alt | string |
The alt-text for the thumbnail. |
Thumbnail URL
|
broadcast.thumbnail_url | string |
The URL address for thumbnail. |
Email Address
|
broadcast.email_address | string |
The email address. |
Email Layout Template
|
broadcast.email_layout_template | string |
The email layout template. |
Create a purchase.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Transaction ID
|
transaction_id | True | string |
The transaction unique identifier. |
Email Address
|
email_address | True | string |
The email address. |
First Name
|
first_name | string |
The first name. |
|
Currency
|
currency | True | string |
The currency. |
Transaction Time
|
transaction_time | string |
The transaction time. |
|
Subtotal
|
subtotal | integer |
The subtotal. |
|
Tax
|
tax | integer |
The tax. |
|
Shipping
|
shipping | integer |
The shipping. |
|
Discount
|
discount | integer |
The discount. |
|
Total
|
total | integer |
The total. |
|
Status
|
status | string |
The status. |
|
PID
|
pid | True | integer |
The personal identifier. |
LID
|
lid | True | integer |
The LID. |
Name
|
name | True | string |
The name. |
SKU
|
sku | string |
The SKU. |
|
Unit Price
|
unit_price | True | integer |
The unit price. |
Quantity
|
quantity | True | integer |
The quantity. |
Returns
Name | Path | Type | Description |
---|---|---|---|
ID
|
id | integer |
The unique identifier. |
Transaction ID
|
transaction_id | string |
The transaction unique identifier. |
Status
|
status | string |
The status. |
Email Address
|
email_address | string |
The email address. |
Currency
|
currency | string |
The currency. |
Transaction Time
|
transaction_time | string |
The transaction time. |
Subtotal
|
subtotal | integer |
The subtotal. |
Discount
|
discount | integer |
The discount. |
Tax
|
tax | integer |
The tax. |
Shipping
|
shipping | integer |
The shipping. |
Total
|
total | integer |
The total. |
Products
|
products | array of object | |
Unit Price
|
products.unit_price | integer |
The unit price. |
Quantity
|
products.quantity | integer |
The quantity. |
SKU
|
products.sku | string |
The SKU. |
Name
|
products.name | string |
The name. |
Creates a new tag.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Name
|
name | True | string |
The name. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Account ID
|
account_id | integer |
The account unique identifier. |
Created At
|
created_at | string |
When created at. |
Deleted At
|
deleted_at | string |
When deleted at. |
ID
|
id | integer |
The unique identifier. |
Name
|
name | string |
The name. |
State
|
state | string |
The state. |
Updated At
|
updated_at | string |
When updated at. |
Permanently delete a draft or scheduled broadcast record. Broadcasts that are currently sending or that have been sent may not be deleted.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Broadcast ID
|
broadcast_id | True | string |
The broadcast unique identifier. |
Returns
- response
- string
Retrieve a specific purchase by ID.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Purchase ID
|
purchase_id | True | string |
The purchase identifier. |
Returns
Name | Path | Type | Description |
---|---|---|---|
ID
|
id | integer |
The unique identifier. |
Transaction ID
|
transaction_id | string |
The transaction unique identifier. |
Status
|
status | string |
The status. |
Email Address
|
email_address | string |
The email address. |
Currency
|
currency | string |
The currency. |
Transaction Time
|
transaction_time | string |
The transaction time. |
Subtotal
|
subtotal | integer |
The subtotal. |
Shipping
|
shipping | integer |
The shipping. |
Discount
|
discount | integer |
The discount. |
Tax
|
tax | integer |
The tax. |
Total
|
total | integer |
The total. |
Products
|
products | array of object | |
Unit Price
|
products.unit_price | integer |
The unit price. |
Quantity
|
products.quantity | integer |
The quantity. |
SKU
|
products.sku | string |
The SKU. |
Name
|
products.name | string |
The name. |
Retrieves a single subscriber record.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Subscriber ID
|
subscriber_id | True | string |
The subscriber unique identifier. |
Returns
Name | Path | Type | Description |
---|---|---|---|
ID
|
subscriber.id | integer |
The unique identifier. |
First Name
|
subscriber.first_name | string |
The first name. |
Email Address
|
subscriber.email_address | string |
The email address. |
State
|
subscriber.state | string |
The state. |
Created At
|
subscriber.created_at | string |
When created at. |
Last Name
|
subscriber.fields.last_name | string |
The last name. |
Retrieves the current account.
Returns
Name | Path | Type | Description |
---|---|---|---|
Name
|
name | string |
The name. |
Plan Type
|
plan_type | string |
The type of plan. |
Primary Email Address
|
primary_email_address | string |
The primary email address. |
Retrieves the statistics (recipient count, open rate, click rate, unsubscribe count, total clicks, status, and send progress) for a specific broadcast.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Broadcast ID
|
broadcast_id | True | string |
The broadcast unique identifier. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Broadcast
|
broadcast | array of object | |
ID
|
broadcast.id | integer |
The unique identifier. |
Recipients
|
broadcast.stats.recipients | integer |
The recipients. |
Open Rate
|
broadcast.stats.open_rate | float |
The open rate. |
Click Rate
|
broadcast.stats.click_rate | float |
The click rate. |
Unsubscribes
|
broadcast.stats.unsubscribes | integer |
The unsubscribes. |
Total Clicks
|
broadcast.stats.total_clicks | integer |
The total clicks. |
Show Total Clicks
|
broadcast.stats.show_total_clicks | boolean |
Whether to show total clicks. |
Status
|
broadcast.stats.status | string |
The status. |
Progress
|
broadcast.stats.progress | integer |
The progress. |
Retrieve a list of all the forms for your account.
Returns
Name | Path | Type | Description |
---|---|---|---|
Forms
|
forms | array of object | |
ID
|
forms.id | integer |
The unique identifier. |
Name
|
forms.name | string |
The name. |
Created At
|
forms.created_at | string |
When created at. |
Type
|
forms.type | string |
The type. |
Format
|
forms.format | string |
The format. |
URL
|
forms.url | string |
The URL address. |
Embed JS
|
forms.embed_js | string |
The Javascript to embed. |
Embed URL
|
forms.embed_url | string |
The URL address to embed. |
Title
|
forms.title | string |
The title. |
Description
|
forms.description | string |
The description. |
Sign Up Button Text
|
forms.sign_up_button_text | string |
The sign up button text. |
Success Message
|
forms.success_message | string |
The success message. |
Archived
|
forms.archived | boolean |
Whether archived. |
UID
|
forms.uid | string |
The unique identifier. |
Retrieves a list of all the broadcasts for your account.
Returns
Name | Path | Type | Description |
---|---|---|---|
Broadcasts
|
broadcasts | array of object | |
ID
|
broadcasts.id | integer |
The unique identifier. |
Created At
|
broadcasts.created_at | string |
When created at. |
Subject
|
broadcasts.subject | string |
The subject. |
Retrieve a list of all purchases for an account.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Page
|
page | integer |
The page. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Total Purchases
|
total_purchases | integer |
The total purchases. |
Page
|
page | integer |
The page. |
Total Pages
|
total_pages | integer |
The total pages. |
Purchases
|
purchases | array of object | |
ID
|
purchases.id | integer |
The unique identifier. |
Transaction ID
|
purchases.transaction_id | string |
The transaction unique identifier. |
Status
|
purchases.status | string |
The status. |
Email Address
|
purchases.email_address | string |
The email address. |
Currency
|
purchases.currency | string |
The currency. |
Transaction Time
|
purchases.transaction_time | string |
The transaction time. |
Subtotal
|
purchases.subtotal | integer |
The subtotal. |
Shipping
|
purchases.shipping | integer |
The shipping. |
Discount
|
purchases.discount | integer |
The discount. |
Tax
|
purchases.tax | integer |
The tax. |
Total
|
purchases.total | integer |
The total. |
Products
|
purchases.products | array of object | |
Unit Price
|
purchases.products.unit_price | integer |
The unit price. |
Quantity
|
purchases.products.quantity | integer |
The quantity. |
SKU
|
purchases.products.sku | string |
The SKU. |
Name
|
purchases.products.name | string |
The name. |
Retrieves a list of sequences for the account.
Returns
Name | Path | Type | Description |
---|---|---|---|
Courses
|
courses | array of object | |
ID
|
courses.id | integer |
The unique identifier. |
Name
|
courses.name | string |
The name. |
Created At
|
courses.created_at | string |
When created at. |
Retrieves a list of all the tags for a subscriber.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Subscriber ID
|
subscriber_id | True | string |
The subscriber unique identifier. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Tags
|
tags | array of object | |
ID
|
tags.id | integer |
The unique identifier. |
Name
|
tags.name | string |
The name. |
Created At
|
tags.created_at | string |
When created at. |
Returns a list of your subscribers. For unsubscribes only, use the cancelled at value for sort field param (currently the only supported extra sort field).
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
From
|
from | string |
The from. |
|
To
|
to | string |
The to. |
|
Updated From
|
updated_from | string |
When updated from. |
|
Updated To
|
updated_to | string |
When updated to. |
|
Sort Order
|
sort_order | string |
The sort order. |
|
Sort Field
|
sort_field | string |
The sort field. |
|
Email Address
|
email_address | string |
The email address. |
|
Page
|
page | integer |
The page. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Total Subscribers
|
total_subscribers | integer |
The total subscribers. |
Page
|
page | integer |
The page. |
Total Pages
|
total_pages | integer |
The total pages. |
Subscribers
|
subscribers | array of object | |
ID
|
subscribers.id | integer |
The unique identifier. |
First Name
|
subscribers.first_name | string |
The first name. |
Email Address
|
subscribers.email_address | string |
The email address. |
State
|
subscribers.state | string |
The state. |
Created At
|
subscribers.created_at | string |
When created at. |
Last Name
|
subscribers.fields.last_name | string |
The last name. |
Retrieves a list of subscriptions to a form including subscriber data.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Form ID
|
form_id | True | string |
The form unique identifier. |
Sort Order
|
sort_order | string |
The sort order. |
|
Subscriber State
|
subscriber_state | string |
The state of the subscriber. |
|
Page
|
page | integer |
The page. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Total Subscriptions
|
total_subscriptions | integer |
The total subscriptions. |
Page
|
page | integer |
The page. |
Total Pages
|
total_pages | integer |
The total pages. |
Subscriptions
|
subscriptions | array of object | |
ID
|
subscriptions.id | integer |
The unique identifier. |
State
|
subscriptions.state | string |
The state. |
Created At
|
subscriptions.created_at | string |
When created at. |
Source
|
subscriptions.source | string |
The source. |
Referrer
|
subscriptions.referrer | string |
The referrer. |
Subscribable ID
|
subscriptions.subscribable_id | integer |
The subscribable unique identifier. |
Subscribable Type
|
subscriptions.subscribable_type | string |
The subscribable type. |
ID
|
subscriptions.subscriber.id | integer |
The unique identifier. |
First Name
|
subscriptions.subscriber.first_name | string |
The first name. |
Email Address
|
subscriptions.subscriber.email_address | string |
The email address. |
State
|
subscriptions.subscriber.state | string |
The state. |
Created At
|
subscriptions.subscriber.created_at | string |
When created at. |
Last Name
|
subscriptions.subscriber.fields.last_name | string |
The last name. |
Retrieves subscriptions to a sequence including subscriber data.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Sequence ID
|
sequence_id | True | string |
The sequence unique identifier. |
Sort Order
|
sort_order | string |
The sort order. |
|
Subscriber State
|
subscriber_state | string |
The state of the subscriber. |
|
Page
|
page | integer |
The page. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Total Subscriptions
|
total_subscriptions | integer |
The total subscriptions. |
Page
|
page | integer |
The page. |
Total Pages
|
total_pages | integer |
The total pages. |
Subscriptions
|
subscriptions | array of object | |
ID
|
subscriptions.id | integer |
The unique identifier. |
State
|
subscriptions.state | string |
The state. |
Created At
|
subscriptions.created_at | string |
When created at. |
Source
|
subscriptions.source | string |
The source. |
Referrer
|
subscriptions.referrer | string |
The referrer. |
Subscribable ID
|
subscriptions.subscribable_id | integer |
The subscribable unique identifier. |
Subscribable Type
|
subscriptions.subscribable_type | string |
The subscribable type. |
ID
|
subscriptions.subscriber.id | integer |
The unique identifier. |
First Name
|
subscriptions.subscriber.first_name | string |
The first name. |
Email Address
|
subscriptions.subscriber.email_address | string |
The email address. |
State
|
subscriptions.subscriber.state | string |
The state. |
Created At
|
subscriptions.subscriber.created_at | string |
When created at. |
Last Name
|
subscriptions.subscriber.fields.last_name | string |
The last name. |
Retrieves a list of subscriptions to a tag including subscriber data.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Tag ID
|
tag_id | True | string |
The tag unique identifier. |
Sort Order
|
sort_order | string |
The sort order. |
|
Subscriber State
|
subscriber_state | string |
The state of the subscriber. |
|
Page
|
page | integer |
The page. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Total Subscriptions
|
total_subscriptions | integer |
The total subscriptions. |
Page
|
page | integer |
The page. |
Total Pages
|
total_pages | integer |
The total pages. |
Subscriptions
|
subscriptions | array of object | |
ID
|
subscriptions.id | integer |
The unique identifier. |
State
|
subscriptions.state | string |
The state. |
Created At
|
subscriptions.created_at | string |
When created at. |
Source
|
subscriptions.source | string |
The source. |
Referrer
|
subscriptions.referrer | string |
The referrer. |
Subscribable ID
|
subscriptions.subscribable_id | integer |
The subscribable unique identifier. |
Subscribable Type
|
subscriptions.subscribable_type | string |
The subscribable type. |
ID
|
subscriptions.subscriber.id | integer |
The unique identifier. |
First Name
|
subscriptions.subscriber.first_name | string |
The first name. |
Email Address
|
subscriptions.subscriber.email_address | string |
The email address. |
State
|
subscriptions.subscriber.state | string |
The state. |
Created At
|
subscriptions.subscriber.created_at | string |
When created at. |
Last Name
|
subscriptions.subscriber.fields.last_name | string |
The last name. |
Retrieves a list of tags for the account.
Returns
Name | Path | Type | Description |
---|---|---|---|
Tags
|
tags | array of object | |
ID
|
tags.id | integer |
The unique identifier. |
Name
|
tags.name | string |
The name. |
Created At
|
tags.created_at | string |
When created at. |
Removes a tag from a subscriber.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Subscriber ID
|
subscriber_id | True | string |
The subscriber unique identifier. |
Tag ID
|
tag_id | True | string |
The tag unique identifier. |
Returns
Name | Path | Type | Description |
---|---|---|---|
ID
|
id | integer |
The unique identifier. |
Name
|
name | string |
The name. |
Created At
|
created_at | string |
When created at. |
Remove a tag from a subscriber by email address.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Tag ID
|
tag_id | True | string |
The tag unique identifier. |
Email
|
True | string |
The email address. |
Returns
Name | Path | Type | Description |
---|---|---|---|
ID
|
id | integer |
The unique identifier. |
Name
|
name | string |
The name. |
Created At
|
created_at | string |
When created at. |
Retrieves the details of a specific broadcast, including draft, scheduled, and previously-sent broadcasts.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Broadcast ID
|
broadcast_id | True | string |
The broadcast unique identifier. |
Returns
Name | Path | Type | Description |
---|---|---|---|
ID
|
broadcast.id | integer |
The unique identifier. |
Created At
|
broadcast.created_at | string |
When created at. |
Subject
|
broadcast.subject | string |
The subject. |
Description
|
broadcast.description | string |
The description. |
Content
|
broadcast.content | string |
The content. |
Public
|
broadcast.public | boolean |
Whether public. |
Published At
|
broadcast.published_at | string |
When published at. |
Send At
|
broadcast.send_at | string |
When sent at. |
Thumbnail Alt
|
broadcast.thumbnail_alt | string |
The alt-text for the thumbnail. |
Thumbnail URL
|
broadcast.thumbnail_url | string |
The URL address for thumbnail. |
Email Address
|
broadcast.email_address | string |
The email address. |
Email Layout Template
|
broadcast.email_layout_template | string |
The email layout template. |
Tags are handled as subscriptions. Subscribe an email address to a tag to have that tag applied to the subscriber with that email address.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Tag ID
|
tag_id | True | string |
The tag unique identifier. |
Email
|
string |
The email address. |
||
First Name
|
first_name | string |
The first name. |
|
Tags
|
tags | array of integer |
Returns
Name | Path | Type | Description |
---|---|---|---|
ID
|
subscription.id | integer |
The unique identifier. |
State
|
subscription.state | string |
The state. |
Created At
|
subscription.created_at | string |
When created at. |
Source
|
subscription.source | string |
The source. |
Referrer
|
subscription.referrer | string |
The referrer. |
Subscribable ID
|
subscription.subscribable_id | integer |
The subscribable unique identifier. |
Subscribable Type
|
subscription.subscribable_type | string |
The subscribable type. |
ID
|
subscription.subscriber.id | integer |
The unique identifier. |
Unsubscribe a subscriber from all your forms and sequences.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Email
|
True | string |
The email address. |
Returns
Name | Path | Type | Description |
---|---|---|---|
ID
|
subscriber.id | integer |
The unique identifier. |
First Name
|
subscriber.first_name | string |
The first name. |
Email Address
|
subscriber.email_address | string |
The email address. |
State
|
subscriber.state | string |
The state. |
Created At
|
subscriber.created_at | string |
When created at. |
Last Name
|
subscriber.fields.last_name | string |
The last name. |
Updates the attributes of a specific broadcast. Broadcasts that are currently sending or that have been sent may not be updated.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Broadcast ID
|
broadcast_id | True | string |
The broadcast unique identifier. |
Description
|
description | string |
The description. |
|
Subject
|
subject | string |
The subject. |
|
Content
|
content | string |
The content. |
|
Email Address
|
email_address | string |
The email address. |
|
Email Layout Template
|
email_layout_template | string |
The email layout template. |
|
Public
|
public | boolean |
Whether public. |
|
Published At
|
published_at | string |
When published at. |
|
Send At
|
send_at | string |
When send at. |
|
Thumbnail Alt
|
thumbnail_alt | string |
The alt-text for the thumbnail. |
|
Thumbnail URL
|
thumbnail_url | string |
The URL address for the thumbnail. |
Returns
Name | Path | Type | Description |
---|---|---|---|
ID
|
broadcast.id | integer |
The unique identifier. |
Created At
|
broadcast.created_at | string |
When created at. |
Subject
|
broadcast.subject | string |
The subject. |
Description
|
broadcast.description | string |
The description. |
Content
|
broadcast.content | string |
The content. |
Public
|
broadcast.public | boolean |
Whether public. |
Published At
|
broadcast.published_at | string |
When published at. |
Send At
|
broadcast.send_at | string |
When sent at. |
Thumbnail Alt
|
broadcast.thumbnail_alt | string |
The alt-text for the thumbnail. |
Thumbnail URL
|
broadcast.thumbnail_url | string |
The URL address for thumbnail. |
Email Address
|
broadcast.email_address | string |
The email address. |
Email Layout Template
|
broadcast.email_layout_template | string |
The email layout template. |
Updates the information for a single subscriber.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Subscriber ID
|
subscriber_id | True | string |
The subscriber unique identifier. |
First Name
|
first_name | string |
The first name. |
|
Email Address
|
email_address | string |
The email address. |
Returns
Name | Path | Type | Description |
---|---|---|---|
ID
|
subscriber.id | integer |
The unique identifier. |
First Name
|
subscriber.first_name | string |
The first name. |
Email Address
|
subscriber.email_address | string |
The email address. |
State
|
subscriber.state | string |
The state. |
Created At
|
subscriber.created_at | string |
When created at. |
This is the basic data type 'string'.