Create a subscriber
create_subscriberAdds a new subscriber to your Kit audience with specified state and custom fields. Requires confirm=true for delivery or membership changes.
Instructions
Create a subscriber. May affect delivery, audience membership, published data or irreversible state. Requires confirm=true.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| state | No | Create subscriber in this state (`active`, `bounced`, `cancelled`, `complained` or `inactive`). Defaults to `active`. | |
| fields | No | Custom field values keyed by the custom field's `key` (e.g. `last_name`, not `Last Name`). Unknown keys are ignored and reported in the response `warnings` array. | |
| account | No | Named private account from KIT_ACCOUNTS. Defaults to KIT_DEFAULT_ACCOUNT or the first configured account. | |
| confirm | No | Must be true for audience/delivery changes, publishing, destructive operations and signing-secret changes. Use only for an action requested by the user. | |
| payload | No | Complete JSON body instead of individual body flags. Supports nullable fields and nested bulk structures. Cannot be combined with body flags or payload_file. | |
| first_name | No | ||
| payload_file | No | Local JSON request body file, at most 5 MB. Contents are validated before the API call and are never logged. | |
| email_address | No |