Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Creates or updates a subscriber by email address.
kit.createSubscriber creates or updates a subscriber by email address.
import { automation, markSignificant } from "automate.ax"
import { kit } from "automate.ax/kit"
export default automation("Create subscriber", () => {
markSignificant(
kit.createSubscriber({
emailAddress: "value",
}),
)
})
| Field | Type | Required | Description |
|---|---|---|---|
firstName | string | null | No | — |
emailAddress | string | Yes | — |
state | "active" | "cancelled" | "bounced" | "complained" | "inactive" | null | No | Create subscriber in this state (active, bounced, cancelled, complained or inactive). Defaults to active. |
fields | object | No | Custom field values keyed by the custom field’s key (for example last_name, not Last Name). Unknown keys are ignored and reported in the response warnings array. |
| Field | Type | Required | Description |
|---|---|---|---|
subscriber | object | Yes | — |
warnings | string[] | No | Present only when the request referenced custom field keys that don’t exist on the account. Each entry names an unknown key that was ignored; the subscriber is still created or updated. |