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

ParameterTypeRequiredDescription
accountIdintegerYesId of the account, from List accounts.
listIdintegerYesId of the list, from List lists.
emailstringYesEmail address of the subscriber.
namestringNoName of the subscriber.
tagsarrayNoTags to apply. Tags can start automations of the account.
custom_fieldsobjectNoValues 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_trackingstringNoLabel of where the subscriber came from.
misc_notesstringNoFree notes about the subscriber.
update_existingstringNotrue 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

See all 12 tools

Toolkits in the same category

See all 100 toolkits

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.