Create subscriber with the AWeber API
Adds a subscriber to a list, which starts the follow-up series of the list. An email already on the list returns 400, unless update_existing is true. Add people one at a time: bulk adding through the API breaks the AWeber terms.
- Identifier
- aweber_create_subscriber
The request
POST https://connect.reportei.com/api/tools/aweber_create_subscriber/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"accountId": 1,
"listId": 1,
"email": "<email>"
}
}Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| accountId | integer | Yes | Id of the account, from List accounts. |
| listId | integer | Yes | Id of the list, from List lists. |
| string | Yes | Email address of the subscriber. | |
| name | string | No | Name of the subscriber. |
| tags | array | No | Tags to apply. Tags can start automations of the account. |
| custom_fields | object | No | Values of the custom fields of the list, keyed by the field name as it appears in the custom_fields of List subscribers. The fields must already exist in the list. |
| ad_tracking | string | No | Label of where the subscriber came from. |
| misc_notes | string | No | Free notes about the subscriber. |
| update_existing | string | No | true updates the subscriber when the email is already on the list, adding the tags and keeping the status. When custom_fields is sent, the fields left out are cleared.Values: true, false |
Supported connections
Your customer connects their AWeber account once, with one of the modes below. The same connection serves every tool of the toolkit.
OAuth with your product's app
You register your product's OAuth app once, with POST /api/merchants/credentials/aweber, and your customer authorizes the account on a consent screen. Connect renews the token when it is about to expire.
The response
On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.
Ready for AI agents
This tool's input is a JSON Schema, available at GET /api/tools/aweber_create_subscriber. It becomes your agent's tool definition with no conversion.
Other AWeber tools
- List accountsGETReturns the AWeber account the connection reaches, in entries, with its id, the accountId every other tool asks for, and the company name.
- List listsGETLists the subscriber lists of the account, in entries, with id, name and the counts of subscribed, unconfirmed and unsubscribed subscribers. Only the first 100 come back; total_size has the count.
- List subscribersGETLists the subscribers of a list, in entries, with id, email, name, status, tags, custom fields and subscription date. Only the first 100 come back, oldest first unless sort_order is desc; total_size has the count.
- Get subscriberGETReturns one subscriber of a list with email, name, status, tags, custom fields, location and the follow-up messages already sent.
- Update subscriberPATCHChanges the subscriber of a list that has the given email. Setting status to unsubscribed stops the emails to the subscriber; tags take an add and a remove list.
- List broadcastsGETLists the broadcast emails of a list in one status, in entries: drafts created through the API, scheduled ones by send time or sent ones by send date. Only the first 100 come back; total_size has the count.
- Get broadcastGETReturns one broadcast email with subject, content, status, schedule, archive URL and, once sent, its stats.
- Create broadcastPOSTCreates a broadcast email as a draft for the list; nothing is sent until Schedule broadcast. The response has the broadcast_id.
See Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
