Send an A/B push notification
pushengage_send_ab_notificationCreate A/B push notifications with two variants, send now or schedule, and optionally enable intelligent auto-winner selection based on click-through rate.
Instructions
Creates an A/B notification on the current site with two variants (variant_a and variant_b). Required: variant_a (title, message, url) and variant_b (title, message, url). By default (intelligent_ab_test omitted) both variants ship as-is to the audience — no automatic winner picking. Pass intelligent_ab_test to enable intelligent / auto-winner mode: each variant is sent to sent_limit_percentage% of subscribers, and after winner_delay_minutes the higher-CTR variant is automatically delivered to the remaining audience (up to sent_limit total). Only include intelligent_ab_test when the user explicitly asks for an intelligent / auto-winner test. Do not add other optional fields (tags, audience_groups, per-variant image_url, utm_params, actions, etc.) unless the user explicitly asks. Audience: by default sends to all subscribers. Pass audience_groups (1-20 predefined audience-group IDs) only when the user mentions a saved/predefined audience group. Use status="schedule" with schedule_date to schedule for later, or status="draft" to save without sending.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| tags | No | Up to 5 tags, 36 chars each. Only when the user explicitly asks for tags. | |
| status | No | Send now (sent), schedule for later (schedule), or save without sending (draft). The API only accepts sent and scheduled in the body; draft is conveyed via the action query param while the body still carries status="sent". | sent |
| site_id | No | Override the currently selected site | |
| variant_a | Yes | A/B variant A. Required. | |
| variant_b | Yes | A/B variant B. Required. | |
| schedule_date | No | Required when status is "schedule". Format: YYYY-MM-DD HH:mm:ss in the site timezone. | |
| audience_groups | No | Send to one or more predefined audience groups (1-20 group IDs). Applies to both variants. Omit to send to all subscribers. Only set when the user mentions a saved/predefined audience group. | |
| intelligent_ab_test | No | OPTIONAL. Enables intelligent A/B testing: each variant is delivered to sent_limit_percentage% of subscribers, then after winner_delay_minutes the variant with the higher click-through rate is automatically sent to the remaining audience (up to sent_limit subscribers total). Omit this field to send a plain A/B where both variants ship as-is to the audience with no automatic winner selection. Only include when the user explicitly asks for an intelligent / auto-winner A/B test. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| status | No | ||
| view_url | No | ||
| notification_id | No | ||
| ab_notification_id | No |