AWeber
App · 27 actions
Manage your AWeber email lists: find, add, tag and update subscribers, keep custom fields, and draft, schedule and review broadcast emails.
Actions
| Action | What it does |
|---|---|
| Add subscriber | Add one person to a mailing list. |
| Cancel scheduled broadcast | Cancel a scheduled broadcast before it is sent. |
| Create broadcast draft | Create a draft email for a mailing list. |
| Create custom field | Add a custom field to a mailing list. |
| Delete broadcast draft | Delete a draft broadcast. |
| Delete custom field | Delete a custom field and the values subscribers have in it. |
| Delete subscriber | Permanently delete a subscriber, with their open and click history. |
| Find a subscriber on any list | Look an email address up on every list of the account and see which lists it is on, with its status on each. |
| Find subscribers | List or search a mailing list's subscribers by email, name, status, tags, sign-up date or method. |
| Get broadcast | Get one broadcast with its content, status and totals. |
| Get campaign | Get one sent broadcast or follow-up email with its totals. |
| Get custom field | Get one custom field of a mailing list. |
| Get mailing list | Get one mailing list with its subscriber counts. |
| Get segment | Get one saved segment of a mailing list. |
| Get subscriber | Get one subscriber with their status, tags, custom fields and where they signed up. |
| Get subscriber activity | List what a subscriber has done: opens, clicks and more, as AWeber records them. |
| List accounts | List the AWeber accounts the connection can reach. |
| List broadcasts | List a mailing list's broadcasts that are sent, scheduled or drafts. |
| List campaigns | List a mailing list's sent broadcasts and follow-up emails with their totals. |
| List custom fields | List a mailing list's custom fields. |
| List mailing lists | List your mailing lists with their subscriber counts, optionally only those whose name contains some text. |
| List segments | List a mailing list's saved segments. |
| List tags | List the tags used on a mailing list, most used first (up to 500). |
| Schedule broadcast | Schedule a draft broadcast to be sent to the list at a time in the future. |
| Update broadcast draft | Change a draft broadcast. |
| Update custom field | Rename a custom field or choose whether subscribers can change it. |
| Update subscriber | Change a subscriber's name, email address, notes, status, tags or custom fields. |
Add subscriber
Add one person to a mailing list. AWeber sends a confirmation email if the list uses one. For large imports use AWeber's list importer.
Inputs
- List
list_idtextRequired - The mailing list. Pick one, or give its ID from an earlier step.
- Email address
emailtextRequired - The new subscriber's email address.
- Name
nametext - The subscriber's name, up to 60 characters.
- Tags
tagslist - Tags to put on the subscriber. Pick from the list's tags or type new ones.
- Custom fields
custom_fieldsobject - Values for the list's custom fields. Fill in only what should change: fields left empty keep their value.
- Notes
misc_notestext - Notes about the subscriber, up to 60 characters.
- Update if already on the list
update_existingtrue/false - Update the subscriber if the address is already on the list, keeping their status and adding the tags. Custom fields you leave empty are cleared. Without this, AWeber refuses an address that is already there.Default:
false.
Outputs
subscriberobject- The new subscriber
Example output
{
"subscriber": {
"account_id": "1234567",
"ad_tracking": "",
"city": "",
"country": "United States",
"custom_fields": {
"Company": "Acme"
},
"email": "jo@example.com",
"id": "34567890",
"ip_address": "",
"is_verified": true,
"last_followup_message_number_sent": 0,
"list_id": "2345678",
"misc_notes": "",
"name": "Jo Bloggs",
"postal_code": "",
"region": "",
"self_link": "https://api.aweber.com/1.0/accounts/1234567/lists/2345678/subscribers/34567890",
"status": "subscribed",
"subscribed_at": "2026-10-01T12:00:00-05:00",
"subscription_method": "api",
"subscription_url": "",
"tags": [
"customer"
],
"unsubscribe_method": "",
"unsubscribed_at": "",
"verified_at": "2026-10-01T12:05:00-05:00"
}
}Cancel scheduled broadcast
Cancel a scheduled broadcast before it is sent. It goes back to being a draft.
Inputs
- List
list_idtextRequired - The mailing list. Pick one, or give its ID from an earlier step.
- Broadcast
broadcast_idtextRequired - The broadcast. Pick one, or give its ID from an earlier step.
Outputs
broadcastobject- The broadcast, back to a draft
Example output
{
"broadcast": {
"archive_url": "",
"body_html": "<p>Hello</p>",
"body_text": "Hello",
"click_tracking_enabled": true,
"id": "678901",
"is_archived": true,
"list_id": "2345678",
"notify_on_send": true,
"scheduled_for": "",
"segment_link": "",
"self_link": "https://api.aweber.com/1.0/accounts/1234567/lists/2345678/broadcasts/678901",
"sent_at": "",
"status": "draft",
"subject": "October news",
"total_clicks": 0,
"total_opens": 0,
"total_sent": 0,
"total_unsubscribes": 0
}
}Create broadcast draft
Create a draft email for a mailing list. Nothing is sent until you schedule it with 'Schedule broadcast'.
Inputs
- List
list_idtextRequired - The mailing list. Pick one, or give its ID from an earlier step.
- Subject
subjecttextRequired - The subject line, up to 120 characters.
- HTML content
body_htmltext - The email's HTML. Give this, the plain text version, or both.
- Plain text content
body_texttext - The email's plain text version.
- Track link clicks
click_tracking_enabledtrue/false - Count clicks on links in the email. AWeber's default is on.
- Add to the list's archive
is_archivedtrue/false - Publish the email on the list's public archive page after it is sent. AWeber's default is on.
- Email me when it is sent
notify_on_sendtrue/false - AWeber emails the account owner after the broadcast goes out. AWeber's default is on.
- Send only to segment
segment_idtext - Send to one saved segment of the list instead of everyone.
Outputs
broadcastobject- The new draft
Example output
{
"broadcast": {
"archive_url": "",
"body_html": "<p>Hello</p>",
"body_text": "Hello",
"click_tracking_enabled": true,
"id": "678901",
"is_archived": true,
"list_id": "2345678",
"notify_on_send": true,
"scheduled_for": "",
"segment_link": "",
"self_link": "https://api.aweber.com/1.0/accounts/1234567/lists/2345678/broadcasts/678901",
"sent_at": "",
"status": "draft",
"subject": "October news",
"total_clicks": 0,
"total_opens": 0,
"total_sent": 0,
"total_unsubscribes": 0
}
}Create custom field
Add a custom field to a mailing list. AWeber limits how many a list can have.
Inputs
- List
list_idtextRequired - The mailing list. Pick one, or give its ID from an earlier step.
- Name
nametextRequired - The field's name, such as Company.
Outputs
custom_fieldobject- The new custom field
Example output
{
"custom_field": {
"id": "456789",
"is_subscriber_updateable": true,
"list_id": "2345678",
"name": "Company"
}
}Delete broadcast draft
Delete a draft broadcast. AWeber deletes only drafts, never sent or scheduled broadcasts.
Inputs
- List
list_idtextRequired - The mailing list. Pick one, or give its ID from an earlier step.
- Broadcast
broadcast_idtextRequired - The broadcast. Pick one, or give its ID from an earlier step.
Outputs
broadcast_idtext- The broadcast deleted
deletedtrue/false- Always true once deleted
list_idtext- The list it belonged to
Example output
{
"broadcast_id": "678901",
"deleted": true,
"list_id": "2345678"
}Delete custom field
Delete a custom field and the values subscribers have in it. Forms and automations that use it can break.
Inputs
- List
list_idtextRequired - The mailing list. Pick one, or give its ID from an earlier step.
- Custom field
custom_field_idtextRequired - The custom field. Pick one, or give its ID from an earlier step.
Outputs
custom_field_idtext- The custom field deleted
deletedtrue/false- Always true once deleted
list_idtext- The list it was on
Example output
{
"custom_field_id": "456789",
"deleted": true,
"list_id": "2345678"
}Delete subscriber
Permanently delete a subscriber, with their open and click history. To stop mailing someone but keep the record, use 'Update subscriber' to set Unsubscribed.
Inputs
- List
list_idtextRequired - The mailing list. Pick one, or give its ID from an earlier step.
- Subscriber
subscribertextRequired - The subscriber's email address, or their ID from 'Find subscribers' or an earlier step.
Outputs
deletedtrue/false- Always true once deleted
list_idtext- The list it was on
subscribertext- The ID or email address deleted
Example output
{
"deleted": true,
"list_id": "2345678",
"subscriber": "34567890"
}Find a subscriber on any list
Look an email address up on every list of the account and see which lists it is on, with its status on each.
Inputs
- Email address
emailtextRequired - The address to look for.
- Status
statustext - Only entries with this status.One of:
subscribed,unsubscribed,unconfirmed(Waiting for confirmation).
Outputs
countnumber- How many are in this answer
subscriberslist- One entry for each list
Example output
{
"count": 1,
"subscribers": [
{
"account_id": "1234567",
"ad_tracking": "",
"city": "",
"country": "United States",
"custom_fields": {
"Company": "Acme"
},
"email": "jo@example.com",
"id": "34567890",
"ip_address": "",
"is_verified": true,
"last_followup_message_number_sent": 0,
"list_id": "2345678",
"misc_notes": "",
"name": "Jo Bloggs",
"postal_code": "",
"region": "",
"self_link": "https://api.aweber.com/1.0/accounts/1234567/lists/2345678/subscribers/34567890",
"status": "subscribed",
"subscribed_at": "2026-10-01T12:00:00-05:00",
"subscription_method": "api",
"subscription_url": "",
"tags": [
"customer"
],
"unsubscribe_method": "",
"unsubscribed_at": "",
"verified_at": "2026-10-01T12:05:00-05:00"
}
]
}Find subscribers
List or search a mailing list's subscribers by email, name, status, tags, sign-up date or method. Gets one page; to see more, run it again with the 'next_start' it gives.
Inputs
- List
list_idtextRequired - The mailing list. Pick one, or give its ID from an earlier step.
- Email address
emailtext - Only the subscriber with exactly this address.
- Name
nametext - Only subscribers with exactly this name.
- Status
statustext - Only subscribers with this status.One of:
subscribed,unsubscribed,unconfirmed(Waiting for confirmation). - Tags
tagslist - Only subscribers who have every one of these tags.
- Subscribed after
subscribed_afterdate and time - Only people who subscribed after this date and time.
- Subscribed before
subscribed_beforedate and time - Only people who subscribed before this date and time.
- How they subscribed
subscription_methodtext - Only people who subscribed this way.One of:
api,email,import,webform(Sign-up form). - Sort by
sort_keytext - What to sort by. AWeber sorts by when they subscribed unless told otherwise.One of:
subscribed_at(When they subscribed),unsubscribed_at(When they unsubscribed). - Order
sort_ordertext - Oldest first (the default) or newest first.One of:
asc(Oldest first),desc(Newest first). - Start at
startnumber - Where to start in the results. 0 (the default) is the first. For the next page, use 'next_start' from the last one.At least 0.
- Page size
limitnumber - How many to return, 1 to 100. The default is 25.From 1 to 100. Default:
25.
Outputs
countnumber- How many are in this answer
has_moretrue/false- True when AWeber has more after these
next_startnumber- The 'Start at' value that gets the next page
subscriberslist- The subscribers
Example output
{
"count": 1,
"has_more": false,
"next_start": 1,
"subscribers": [
{
"account_id": "1234567",
"ad_tracking": "",
"city": "",
"country": "United States",
"custom_fields": {
"Company": "Acme"
},
"email": "jo@example.com",
"id": "34567890",
"ip_address": "",
"is_verified": true,
"last_followup_message_number_sent": 0,
"list_id": "2345678",
"misc_notes": "",
"name": "Jo Bloggs",
"postal_code": "",
"region": "",
"self_link": "https://api.aweber.com/1.0/accounts/1234567/lists/2345678/subscribers/34567890",
"status": "subscribed",
"subscribed_at": "2026-10-01T12:00:00-05:00",
"subscription_method": "api",
"subscription_url": "",
"tags": [
"customer"
],
"unsubscribe_method": "",
"unsubscribed_at": "",
"verified_at": "2026-10-01T12:05:00-05:00"
}
]
}Get broadcast
Get one broadcast with its content, status and totals.
Inputs
- List
list_idtextRequired - The mailing list. Pick one, or give its ID from an earlier step.
- Broadcast
broadcast_idtextRequired - The broadcast. Pick one, or give its ID from an earlier step.
Outputs
broadcastobject- The broadcast
Example output
{
"broadcast": {
"archive_url": "",
"body_html": "<p>Hello</p>",
"body_text": "Hello",
"click_tracking_enabled": true,
"id": "678901",
"is_archived": true,
"list_id": "2345678",
"notify_on_send": true,
"scheduled_for": "",
"segment_link": "",
"self_link": "https://api.aweber.com/1.0/accounts/1234567/lists/2345678/broadcasts/678901",
"sent_at": "",
"status": "draft",
"subject": "October news",
"total_clicks": 0,
"total_opens": 0,
"total_sent": 0,
"total_unsubscribes": 0
}
}Get campaign
Get one sent broadcast or follow-up email with its totals.
Inputs
- List
list_idtextRequired - The mailing list. Pick one, or give its ID from an earlier step.
- Type
campaign_typetext - Whether it is a broadcast or a follow-up.One of:
b(Broadcast),f(Follow-up). Default:b. - Campaign ID
campaign_idtextRequired - The campaign's ID, from 'List campaigns' or an earlier step.
Outputs
campaignobject- The campaign
Example output
{
"campaign": {
"campaign_type": "b",
"content_type": "",
"id": "678901",
"is_archived": false,
"list_id": "2345678",
"message_number": 0,
"scheduled_at": "",
"self_link": "https://api.aweber.com/1.0/accounts/1234567/lists/2345678/campaigns/b678901",
"sent_at": "2026-09-15T10:00:00-05:00",
"subject": "September news",
"total_clicks": 9,
"total_opens": 42,
"total_sent": 100,
"total_spam_complaints": 0,
"total_undelivered": 0,
"total_unsubscribes": 1
}
}Get custom field
Get one custom field of a mailing list.
Inputs
- List
list_idtextRequired - The mailing list. Pick one, or give its ID from an earlier step.
- Custom field
custom_field_idtextRequired - The custom field. Pick one, or give its ID from an earlier step.
Outputs
custom_fieldobject- The custom field
Example output
{
"custom_field": {
"id": "456789",
"is_subscriber_updateable": true,
"list_id": "2345678",
"name": "Company"
}
}Get mailing list
Get one mailing list with its subscriber counts.
Inputs
- List
list_idtextRequired - The mailing list. Pick one, or give its ID from an earlier step.
Outputs
listobject- The mailing list
Example output
{
"list": {
"account_id": "1234567",
"id": "2345678",
"name": "Newsletter",
"subscribed_today": 2,
"subscribed_yesterday": 3,
"total_subscribed": 100,
"total_subscribers": 120,
"total_unconfirmed": 8,
"total_unsubscribed": 12,
"unique_list_id": "awlist2345678"
}
}Get segment
Get one saved segment of a mailing list.
Inputs
- List
list_idtextRequired - The mailing list. Pick one, or give its ID from an earlier step.
- Segment
segment_idtextRequired - The segment. Pick one, or give its ID from an earlier step.
Outputs
segmentobject- The segment
Example output
{
"segment": {
"id": "567890",
"is_split_test": false,
"list_id": "2345678",
"name": "Customers"
}
}Get subscriber
Get one subscriber with their status, tags, custom fields and where they signed up.
Inputs
- List
list_idtextRequired - The mailing list. Pick one, or give its ID from an earlier step.
- Subscriber
subscribertextRequired - The subscriber's email address, or their ID from 'Find subscribers' or an earlier step.
Outputs
subscriberobject- The subscriber
Example output
{
"subscriber": {
"account_id": "1234567",
"ad_tracking": "",
"city": "",
"country": "United States",
"custom_fields": {
"Company": "Acme"
},
"email": "jo@example.com",
"id": "34567890",
"ip_address": "",
"is_verified": true,
"last_followup_message_number_sent": 0,
"list_id": "2345678",
"misc_notes": "",
"name": "Jo Bloggs",
"postal_code": "",
"region": "",
"self_link": "https://api.aweber.com/1.0/accounts/1234567/lists/2345678/subscribers/34567890",
"status": "subscribed",
"subscribed_at": "2026-10-01T12:00:00-05:00",
"subscription_method": "api",
"subscription_url": "",
"tags": [
"customer"
],
"unsubscribe_method": "",
"unsubscribed_at": "",
"verified_at": "2026-10-01T12:05:00-05:00"
}
}Get subscriber activity
List what a subscriber has done: opens, clicks and more, as AWeber records them.
Inputs
- List
list_idtextRequired - The mailing list. Pick one, or give its ID from an earlier step.
- Subscriber
subscribertextRequired - The subscriber's email address, or their ID from 'Find subscribers' or an earlier step.
- Start at
startnumber - Where to start in the results. 0 (the default) is the first. For the next page, use 'next_start' from the last one.At least 0.
- Page size
limitnumber - How many to return, 1 to 100. The default is 25.From 1 to 100. Default:
25.
Outputs
activitylist- The activity
countnumber- How many are in this answer
has_moretrue/false- True when AWeber has more after these
next_startnumber- The 'Start at' value that gets the next page
Example output
{
"activity": [
{
"event_time": "2026-10-02T09:00:00-05:00",
"id": "1",
"subscriber_link": "https://api.aweber.com/1.0/accounts/1234567/lists/2345678/subscribers/34567890",
"type": "open"
}
],
"count": 1,
"has_more": false,
"next_start": 1
}List accounts
List the AWeber accounts the connection can reach. Most people have one.
Inputs
None.
Outputs
accountslist- The accounts
countnumber- How many are in this answer
Example output
{
"accounts": [
{
"id": "1234567",
"self_link": "https://api.aweber.com/1.0/accounts/1234567"
}
],
"count": 1
}List broadcasts
List a mailing list's broadcasts that are sent, scheduled or drafts. AWeber lists only drafts made through the API. Gets one page; to see more, run it again with the 'next_start' it gives.
Inputs
- List
list_idtextRequired - The mailing list. Pick one, or give its ID from an earlier step.
- Status
statustext - Which broadcasts to list. Defaults to sent.One of:
sent,scheduled,draft. Default:sent. - Start at
startnumber - Where to start in the results. 0 (the default) is the first. For the next page, use 'next_start' from the last one.At least 0.
- Page size
limitnumber - How many to return, 1 to 100. The default is 25.From 1 to 100. Default:
25.
Outputs
broadcastslist- The broadcasts
countnumber- How many are in this answer
has_moretrue/false- True when AWeber has more after these
next_startnumber- The 'Start at' value that gets the next page
Example output
{
"broadcasts": [
{
"archive_url": "",
"body_html": "<p>Hello</p>",
"body_text": "Hello",
"click_tracking_enabled": true,
"id": "678901",
"is_archived": true,
"list_id": "2345678",
"notify_on_send": true,
"scheduled_for": "",
"segment_link": "",
"self_link": "https://api.aweber.com/1.0/accounts/1234567/lists/2345678/broadcasts/678901",
"sent_at": "",
"status": "draft",
"subject": "October news",
"total_clicks": 0,
"total_opens": 0,
"total_sent": 0,
"total_unsubscribes": 0
}
],
"count": 1,
"has_more": false,
"next_start": 1
}List campaigns
List a mailing list's sent broadcasts and follow-up emails with their totals. Gets one page; to see more, run it again with the 'next_start' it gives.
Inputs
- List
list_idtextRequired - The mailing list. Pick one, or give its ID from an earlier step.
- Type
campaign_typetext - Only broadcasts, or only follow-ups. Leave empty for both.One of:
b(Broadcast),f(Follow-up). - Start at
startnumber - Where to start in the results. 0 (the default) is the first. For the next page, use 'next_start' from the last one.At least 0.
- Page size
limitnumber - How many to return, 1 to 100. The default is 25.From 1 to 100. Default:
25.
Outputs
campaignslist- The campaigns
countnumber- How many are in this answer
has_moretrue/false- True when AWeber has more after these
next_startnumber- The 'Start at' value that gets the next page
Example output
{
"campaigns": [
{
"campaign_type": "b",
"content_type": "",
"id": "678901",
"is_archived": false,
"list_id": "2345678",
"message_number": 0,
"scheduled_at": "",
"self_link": "https://api.aweber.com/1.0/accounts/1234567/lists/2345678/campaigns/b678901",
"sent_at": "2026-09-15T10:00:00-05:00",
"subject": "September news",
"total_clicks": 9,
"total_opens": 42,
"total_sent": 100,
"total_spam_complaints": 0,
"total_undelivered": 0,
"total_unsubscribes": 1
}
],
"count": 1,
"has_more": false,
"next_start": 1
}List custom fields
List a mailing list's custom fields.
Inputs
- List
list_idtextRequired - The mailing list. Pick one, or give its ID from an earlier step.
- Start at
startnumber - Where to start in the results. 0 (the default) is the first. For the next page, use 'next_start' from the last one.At least 0.
- Page size
limitnumber - How many to return, 1 to 100. The default is 25.From 1 to 100. Default:
25.
Outputs
countnumber- How many are in this answer
custom_fieldslist- The custom fields
has_moretrue/false- True when AWeber has more after these
next_startnumber- The 'Start at' value that gets the next page
Example output
{
"count": 1,
"custom_fields": [
{
"id": "456789",
"is_subscriber_updateable": true,
"list_id": "2345678",
"name": "Company"
}
],
"has_more": false,
"next_start": 1
}List mailing lists
List your mailing lists with their subscriber counts, optionally only those whose name contains some text.
Inputs
- Name contains
nametext - Only lists whose name contains this text.
Outputs
countnumber- How many are in this answer
listslist- The mailing lists
Example output
{
"count": 1,
"lists": [
{
"account_id": "1234567",
"id": "2345678",
"name": "Newsletter",
"subscribed_today": 2,
"subscribed_yesterday": 3,
"total_subscribed": 100,
"total_subscribers": 120,
"total_unconfirmed": 8,
"total_unsubscribed": 12,
"unique_list_id": "awlist2345678"
}
]
}List segments
List a mailing list's saved segments.
Inputs
- List
list_idtextRequired - The mailing list. Pick one, or give its ID from an earlier step.
- Start at
startnumber - Where to start in the results. 0 (the default) is the first. For the next page, use 'next_start' from the last one.At least 0.
- Page size
limitnumber - How many to return, 1 to 100. The default is 25.From 1 to 100. Default:
25.
Outputs
countnumber- How many are in this answer
has_moretrue/false- True when AWeber has more after these
next_startnumber- The 'Start at' value that gets the next page
segmentslist- The segments
Example output
{
"count": 1,
"has_more": false,
"next_start": 1,
"segments": [
{
"id": "567890",
"is_split_test": false,
"list_id": "2345678",
"name": "Customers"
}
]
}List tags
List the tags used on a mailing list, most used first (up to 500).
Inputs
- List
list_idtextRequired - The mailing list. Pick one, or give its ID from an earlier step.
Outputs
countnumber- How many are in this answer
tagslist- The tags
Example output
{
"count": 2,
"tags": [
"customer",
"webinar"
]
}Schedule broadcast
Schedule a draft broadcast to be sent to the list at a time in the future. Use 'Cancel scheduled broadcast' to undo it before then.
Inputs
- List
list_idtextRequired - The mailing list. Pick one, or give its ID from an earlier step.
- Broadcast
broadcast_idtextRequired - The broadcast. Pick one, or give its ID from an earlier step.
- Send at
scheduled_fordate and timeRequired - When to send it. Must be in the future.
Outputs
broadcastobject- The scheduled broadcast
Example output
{
"broadcast": {
"archive_url": "",
"body_html": "<p>Hello</p>",
"body_text": "Hello",
"click_tracking_enabled": true,
"id": "678901",
"is_archived": true,
"list_id": "2345678",
"notify_on_send": true,
"scheduled_for": "2026-12-01T15:00:00Z",
"segment_link": "",
"self_link": "https://api.aweber.com/1.0/accounts/1234567/lists/2345678/broadcasts/678901",
"sent_at": "",
"status": "scheduled",
"subject": "October news",
"total_clicks": 0,
"total_opens": 0,
"total_sent": 0,
"total_unsubscribes": 0
}
}Update broadcast draft
Change a draft broadcast. Only what you fill in changes; a scheduled broadcast must be cancelled first.
Inputs
- List
list_idtextRequired - The mailing list. Pick one, or give its ID from an earlier step.
- Broadcast
broadcast_idtextRequired - The broadcast. Pick one, or give its ID from an earlier step.
- Subject
subjecttext - A new subject line, up to 120 characters.
- HTML content
body_htmltext - The email's HTML. Give this, the plain text version, or both.
- Plain text content
body_texttext - The email's plain text version.
- Track link clicks
click_tracking_enabledtrue/false - Count clicks on links in the email. AWeber's default is on.
- Add to the list's archive
is_archivedtrue/false - Publish the email on the list's public archive page after it is sent. AWeber's default is on.
- Email me when it is sent
notify_on_sendtrue/false - AWeber emails the account owner after the broadcast goes out. AWeber's default is on.
- Send only to segment
segment_idtext - Send to one saved segment of the list instead of everyone.
Outputs
broadcastobject- The updated draft
Example output
{
"broadcast": {
"archive_url": "",
"body_html": "<p>Hello</p>",
"body_text": "Hello",
"click_tracking_enabled": true,
"id": "678901",
"is_archived": true,
"list_id": "2345678",
"notify_on_send": true,
"scheduled_for": "",
"segment_link": "",
"self_link": "https://api.aweber.com/1.0/accounts/1234567/lists/2345678/broadcasts/678901",
"sent_at": "",
"status": "draft",
"subject": "October news",
"total_clicks": 0,
"total_opens": 0,
"total_sent": 0,
"total_unsubscribes": 0
}
}Update custom field
Rename a custom field or choose whether subscribers can change it. Renaming can break forms and automations that use the old name.
Inputs
- List
list_idtextRequired - The mailing list. Pick one, or give its ID from an earlier step.
- Custom field
custom_field_idtextRequired - The custom field. Pick one, or give its ID from an earlier step.
- New name
nametext - The field's new name.
- Subscribers can change it
is_subscriber_updateabletrue/false - Let subscribers change this field themselves in AWeber's preference pages.
Outputs
custom_fieldobject- The updated custom field
Example output
{
"custom_field": {
"id": "456789",
"is_subscriber_updateable": true,
"list_id": "2345678",
"name": "Company"
}
}Update subscriber
Change a subscriber's name, email address, notes, status, tags or custom fields. Only what you fill in changes.
Inputs
- List
list_idtextRequired - The mailing list. Pick one, or give its ID from an earlier step.
- Subscriber
subscribertextRequired - The subscriber's email address, or their ID from 'Find subscribers' or an earlier step.
- New email address
emailtext - A new email address for the subscriber.
- Name
nametext - The subscriber's name, up to 60 characters.
- Status
statustext - Set to Unsubscribed to unsubscribe them, or Subscribed to resubscribe.One of:
subscribed,unsubscribed. - Add tags
add_tagslist - Tags to add. Pick from the list's tags or type new ones.
- Remove tags
remove_tagslist - Tags to take off.
- Custom fields
custom_fieldsobject - Values for the list's custom fields. Fill in only what should change: fields left empty keep their value.
- Notes
misc_notestext - Notes about the subscriber, up to 60 characters.
Outputs
subscriberobject- The updated subscriber
Example output
{
"subscriber": {
"account_id": "1234567",
"ad_tracking": "",
"city": "",
"country": "United States",
"custom_fields": {
"Company": "Acme"
},
"email": "jo@example.com",
"id": "34567890",
"ip_address": "",
"is_verified": true,
"last_followup_message_number_sent": 0,
"list_id": "2345678",
"misc_notes": "",
"name": "Jo Bloggs",
"postal_code": "",
"region": "",
"self_link": "https://api.aweber.com/1.0/accounts/1234567/lists/2345678/subscribers/34567890",
"status": "subscribed",
"subscribed_at": "2026-10-01T12:00:00-05:00",
"subscription_method": "api",
"subscription_url": "",
"tags": [
"customer"
],
"unsubscribe_method": "",
"unsubscribed_at": "",
"verified_at": "2026-10-01T12:05:00-05:00"
}
}