Who an email would reach
- Credentials
- OAuth access token
- Scopes
messages:send- Add-on
- Marketing plus
How many customers each audience would reach by email (only those who said yes to marketing), what one campaign to it costs in credits (1 per 10 people), the credits left and the recent campaigns. With audience, also how many of that audience have not opted in.
Plan: Marketing Plus (included with Growth and Scale), else 403 plan_limit.
Access: OAuth scope messages:send; not write-gated. Comes with Growth.
merchantOAuth messages:sendAuthorizationBearer <token>OAuth 2.1 (authorization code + PKCE S256, public clients, dynamic registration) for connected AI apps. Effective power is scopes granted AND the person's role today AND the plan. orders:refund, billing:write and team:write are opt-in on the consent screen. Write implies read for marketing:read and messages:read, so a grant holding marketing:write passes a marketing:read check, and messages:send passes messages:read.
Scope: messages:send
storeId*stringA store the person can reach. Any other id answers 404, never 403.
audience?string"all""best""repeat""one_time""lapsed""new""never_ordered"OK
application/json- response
data*curl -X GET 'https://api.shopeazy.co/v1/merchant/stores/<storeId>/campaigns/audiences' \ -H 'Authorization: Bearer <access_token>'{ "data": { "audiences": [ { "id": "all", "name": "string", "blurb": "string", "reach": 0, "credits": 0 } ], "chosen": null, "creditsLeft": 0, "recent": [ { "subject": "string", "audienceId": "all", "sent": 0, "sentAt": 0 } ] }}Post a draft now POST
Publishes a draft (or retries a failed one) to the shop's Facebook Page and/or Instagram right now, publicly, in the shop's name. A channel that already went out is never posted twice, and a post that already went out is returned as it is. Needs a connected Facebook Page. Owner or admin. Access: OAuth scope `marketing:write`; write-gated by the subscription.
Send a campaign proof to the signed-in person POST
The campaign, sent to the signed-in person only, to check how it looks. Free. Nobody else gets it, and nothing is recorded as a campaign. Owner or admin. Plan: Marketing Plus (included with Growth and Scale), else 403 `plan_limit`. Access: OAuth scope `messages:send`; write-gated by the subscription. Comes with Growth.